network_taps

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

Overview

Name	network_taps
Type	Resource
Id	azure.managed_network_fabric.network_taps

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
tags	object	Resource tags.

list_by_resource_group

Lists all NetworkTaps under the resource group.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
tags	object	Resource tags.

list_by_subscription

Lists all NetworkTaps under the subscription.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Resource properties.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, networkTapName		Retrieves details of this Network Tap.
list_by_resource_group	select	subscriptionId, resourceGroupName		Displays Network Taps list by resource group GET method.
list_by_subscription	select	subscriptionId		Displays Network Taps list by subscription GET method.
create	insert	subscriptionId, resourceGroupName, networkTapName, data__properties		Creates a Network Tap.
update	update	subscriptionId, resourceGroupName, networkTapName		API to update certain properties of the Network Tap resource.
delete	delete	subscriptionId, resourceGroupName, networkTapName		Deletes Network Tap.
resync	exec	subscriptionId, resourceGroupName, networkTapName		Implements the operation to the underlying resources.

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
networkTapName	string	Name of the Network Tap.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Retrieves details of this Network Tap.

SELECT
location,
properties,
tags
FROM azure.managed_network_fabric.network_taps
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkTapName = '{{ networkTapName }}' -- required
;

list_by_resource_group

Displays Network Taps list by resource group GET method.

SELECT
location,
properties,
tags
FROM azure.managed_network_fabric.network_taps
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Displays Network Taps list by subscription GET method.

SELECT
location,
properties,
tags
FROM azure.managed_network_fabric.network_taps
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates a Network Tap.

INSERT INTO azure.managed_network_fabric.network_taps (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
networkTapName
)
SELECT 
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ networkTapName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: network_taps
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the network_taps resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the network_taps resource.
    - name: networkTapName
      value: string
      description: Required parameter for the network_taps resource.
    - name: properties
      value: object
      description: |
        Resource properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

API to update certain properties of the Network Tap resource.

UPDATE azure.managed_network_fabric.network_taps
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND networkTapName = '{{ networkTapName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes Network Tap.

DELETE FROM azure.managed_network_fabric.network_taps
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND networkTapName = '{{ networkTapName }}' --required
;

Lifecycle Methods

resync

Implements the operation to the underlying resources.

EXEC azure.managed_network_fabric.network_taps.resync 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkTapName='{{ networkTapName }}' --required
;