network_tap_rules

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

Overview

Name	network_tap_rules
Type	Resource
Id	azure.managed_network_fabric.network_tap_rules

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 Network Tap Rules 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 NetworkTapRules 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, networkTapRuleName		Get Network Tap Rule resource details.
list_by_resource_group	select	subscriptionId, resourceGroupName		List all the Network Tap Rule resources in the given resource group.
list_by_subscription	select	subscriptionId		List all the Network Tap Rule resources in the given subscription.
create	insert	subscriptionId, resourceGroupName, networkTapRuleName, data__properties		Create Network Tap Rule resource.
update	update	subscriptionId, resourceGroupName, networkTapRuleName		Update certain properties of the Network Tap Rule resource.
delete	delete	subscriptionId, resourceGroupName, networkTapRuleName		Delete Network Tap Rule resource.
resync	exec	subscriptionId, resourceGroupName, networkTapRuleName		Implements the operation to the underlying resources.
validate_configuration	exec	subscriptionId, resourceGroupName, networkTapRuleName		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
networkTapRuleName	string	Name of the Network Tap Rule.
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

Get Network Tap Rule resource details.

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

list_by_resource_group

List all the Network Tap Rule resources in the given resource group.

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

list_by_subscription

List all the Network Tap Rule resources in the given subscription.

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

INSERT examples

create

Create Network Tap Rule resource.

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

Manifest

# Description fields are for documentation purposes
- name: network_tap_rules
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the network_tap_rules resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the network_tap_rules resource.
    - name: networkTapRuleName
      value: string
      description: Required parameter for the network_tap_rules 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

Update certain properties of the Network Tap Rule resource.

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

DELETE examples

delete

Delete Network Tap Rule resource.

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

Lifecycle Methods

resync

Implements the operation to the underlying resources.

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

validate_configuration

Implements the operation to the underlying resources.

EXEC azure.managed_network_fabric.network_tap_rules.validate_configuration 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkTapRuleName='{{ networkTapRuleName }}' --required
;