network_tap_rules

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

Overview

Name	network_tap_rules
Type	Resource
Id	azure_extras.managed_network_fabric.network_tap_rules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
administrativeState	string	Administrative state of the resource. Known values are: "Enabled", "Disabled", "MAT", "RMA", "UnderMaintenance", and "EnabledDegraded". (Enabled, Disabled, MAT, RMA, UnderMaintenance, EnabledDegraded)
annotation	string	Switch configuration description.
configurationState	string	Configuration state of the resource. Known values are: "Succeeded", "Failed", "Rejected", "Accepted", "Provisioned", "ErrorProvisioning", "Deprovisioning", "Deprovisioned", "ErrorDeprovisioning", "DeferredControl", "Provisioning", "PendingCommit", and "PendingAdministrativeUpdate". (Succeeded, Failed, Rejected, Accepted, Provisioned, ErrorProvisioning, Deprovisioning, Deprovisioned, ErrorDeprovisioning, DeferredControl, Provisioning, PendingCommit, PendingAdministrativeUpdate)
configurationType	string	Input method to configure Network Tap Rule. Required. Known values are: "File" and "Inline". (File, Inline)
dynamicMatchConfigurations	array	List of dynamic match configurations.
globalNetworkTapRuleActions	object	Global network tap rule actions.
identity	object	The managed service identities assigned to this resource.
identitySelector	object	The selection of the managed identity to use with this storage account. The identity type must be either system assigned or user assigned.
lastOperation	object	Details of the last operation performed on the resource.
lastSyncedTime	string (date-time)	The last sync timestamp.
location	string	The geo-location where the resource lives. Required.
matchConfigurations	array	List of match configurations.
networkFabricIds	array	Associated Network Fabric Resource IDs.
networkTapId	string	The ARM resource Id of the NetworkTap.
networkTapIds	array	The ARM resource Id of the NetworkTap Rules.
pollingIntervalInSeconds	integer	Polling interval in seconds.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
tapRulesUrl	string	Network Tap Rules file URL.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
administrativeState	string	Administrative state of the resource. Known values are: "Enabled", "Disabled", "MAT", "RMA", "UnderMaintenance", and "EnabledDegraded". (Enabled, Disabled, MAT, RMA, UnderMaintenance, EnabledDegraded)
annotation	string	Switch configuration description.
configurationState	string	Configuration state of the resource. Known values are: "Succeeded", "Failed", "Rejected", "Accepted", "Provisioned", "ErrorProvisioning", "Deprovisioning", "Deprovisioned", "ErrorDeprovisioning", "DeferredControl", "Provisioning", "PendingCommit", and "PendingAdministrativeUpdate". (Succeeded, Failed, Rejected, Accepted, Provisioned, ErrorProvisioning, Deprovisioning, Deprovisioned, ErrorDeprovisioning, DeferredControl, Provisioning, PendingCommit, PendingAdministrativeUpdate)
configurationType	string	Input method to configure Network Tap Rule. Required. Known values are: "File" and "Inline". (File, Inline)
dynamicMatchConfigurations	array	List of dynamic match configurations.
globalNetworkTapRuleActions	object	Global network tap rule actions.
identity	object	The managed service identities assigned to this resource.
identitySelector	object	The selection of the managed identity to use with this storage account. The identity type must be either system assigned or user assigned.
lastOperation	object	Details of the last operation performed on the resource.
lastSyncedTime	string (date-time)	The last sync timestamp.
location	string	The geo-location where the resource lives. Required.
matchConfigurations	array	List of match configurations.
networkFabricIds	array	Associated Network Fabric Resource IDs.
networkTapId	string	The ARM resource Id of the NetworkTap.
networkTapIds	array	The ARM resource Id of the NetworkTap Rules.
pollingIntervalInSeconds	integer	Polling interval in seconds.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
tapRulesUrl	string	Network Tap Rules file URL.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
administrativeState	string	Administrative state of the resource. Known values are: "Enabled", "Disabled", "MAT", "RMA", "UnderMaintenance", and "EnabledDegraded". (Enabled, Disabled, MAT, RMA, UnderMaintenance, EnabledDegraded)
annotation	string	Switch configuration description.
configurationState	string	Configuration state of the resource. Known values are: "Succeeded", "Failed", "Rejected", "Accepted", "Provisioned", "ErrorProvisioning", "Deprovisioning", "Deprovisioned", "ErrorDeprovisioning", "DeferredControl", "Provisioning", "PendingCommit", and "PendingAdministrativeUpdate". (Succeeded, Failed, Rejected, Accepted, Provisioned, ErrorProvisioning, Deprovisioning, Deprovisioned, ErrorDeprovisioning, DeferredControl, Provisioning, PendingCommit, PendingAdministrativeUpdate)
configurationType	string	Input method to configure Network Tap Rule. Required. Known values are: "File" and "Inline". (File, Inline)
dynamicMatchConfigurations	array	List of dynamic match configurations.
globalNetworkTapRuleActions	object	Global network tap rule actions.
identity	object	The managed service identities assigned to this resource.
identitySelector	object	The selection of the managed identity to use with this storage account. The identity type must be either system assigned or user assigned.
lastOperation	object	Details of the last operation performed on the resource.
lastSyncedTime	string (date-time)	The last sync timestamp.
location	string	The geo-location where the resource lives. Required.
matchConfigurations	array	List of match configurations.
networkFabricIds	array	Associated Network Fabric Resource IDs.
networkTapId	string	The ARM resource Id of the NetworkTap.
networkTapIds	array	The ARM resource Id of the NetworkTap Rules.
pollingIntervalInSeconds	integer	Polling interval in seconds.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
tapRulesUrl	string	Network Tap Rules file URL.
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	resource_group_name, network_tap_rule_name, subscription_id		Get Network Tap Rule resource details.
list_by_resource_group	select	resource_group_name, subscription_id		List all the Network Tap Rule resources in the given resource group.
list_by_subscription	select	subscription_id		List all the Network Tap Rule resources in the given subscription.
create	insert	resource_group_name, network_tap_rule_name, subscription_id, location, properties		Create Network Tap Rule resource.
update	update	resource_group_name, network_tap_rule_name, subscription_id		Update certain properties of the Network Tap Rule resource.
delete	delete	resource_group_name, network_tap_rule_name, subscription_id		Delete Network Tap Rule resource.
update_administrative_state	exec	resource_group_name, network_tap_rule_name, subscription_id		Implements the operation to the underlying resources.
resync	exec	resource_group_name, network_tap_rule_name, subscription_id		Implements the operation to the underlying resources.
validate_configuration	exec	resource_group_name, network_tap_rule_name, subscription_id		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
network_tap_rule_name	string	Name of the Network Tap Rule. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get Network Tap Rule resource details.

SELECT
id,
name,
administrativeState,
annotation,
configurationState,
configurationType,
dynamicMatchConfigurations,
globalNetworkTapRuleActions,
identity,
identitySelector,
lastOperation,
lastSyncedTime,
location,
matchConfigurations,
networkFabricIds,
networkTapId,
networkTapIds,
pollingIntervalInSeconds,
provisioningState,
systemData,
tags,
tapRulesUrl,
type
FROM azure_extras.managed_network_fabric.network_tap_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_tap_rule_name = '{{ network_tap_rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

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

SELECT
id,
name,
administrativeState,
annotation,
configurationState,
configurationType,
dynamicMatchConfigurations,
globalNetworkTapRuleActions,
identity,
identitySelector,
lastOperation,
lastSyncedTime,
location,
matchConfigurations,
networkFabricIds,
networkTapId,
networkTapIds,
pollingIntervalInSeconds,
provisioningState,
systemData,
tags,
tapRulesUrl,
type
FROM azure_extras.managed_network_fabric.network_tap_rules
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

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

SELECT
id,
name,
administrativeState,
annotation,
configurationState,
configurationType,
dynamicMatchConfigurations,
globalNetworkTapRuleActions,
identity,
identitySelector,
lastOperation,
lastSyncedTime,
location,
matchConfigurations,
networkFabricIds,
networkTapId,
networkTapIds,
pollingIntervalInSeconds,
provisioningState,
systemData,
tags,
tapRulesUrl,
type
FROM azure_extras.managed_network_fabric.network_tap_rules
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create Network Tap Rule resource.

INSERT INTO azure_extras.managed_network_fabric.network_tap_rules (
tags,
location,
properties,
identity,
resource_group_name,
network_tap_rule_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ identity }}',
'{{ resource_group_name }}',
'{{ network_tap_rule_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: network_tap_rules
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_tap_rules resource.
  - name: network_tap_rule_name
    value: "{{ network_tap_rule_name }}"
    description: Required parameter for the network_tap_rules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_tap_rules resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The NetworkTapRule Properties. Required.
    value:
      annotation: "{{ annotation }}"
      configurationType: "{{ configurationType }}"
      tapRulesUrl: "{{ tapRulesUrl }}"
      identitySelector:
        identityType: "{{ identityType }}"
        userAssignedIdentityResourceId: "{{ userAssignedIdentityResourceId }}"
      matchConfigurations:
        - matchConfigurationName: "{{ matchConfigurationName }}"
          sequenceNumber: {{ sequenceNumber }}
          ipAddressType: "{{ ipAddressType }}"
          matchConditions: "{{ matchConditions }}"
          actions: "{{ actions }}"
      dynamicMatchConfigurations:
        - ipGroups: "{{ ipGroups }}"
          vlanGroups: "{{ vlanGroups }}"
          portGroups: "{{ portGroups }}"
      networkTapId: "{{ networkTapId }}"
      networkTapIds:
        - "{{ networkTapIds }}"
      pollingIntervalInSeconds: {{ pollingIntervalInSeconds }}
      lastSyncedTime: "{{ lastSyncedTime }}"
      globalNetworkTapRuleActions:
        enableCount: "{{ enableCount }}"
        truncate: "{{ truncate }}"
      lastOperation:
        details: "{{ details }}"
      networkFabricIds:
        - "{{ networkFabricIds }}"
      configurationState: "{{ configurationState }}"
      provisioningState: "{{ provisioningState }}"
      administrativeState: "{{ administrativeState }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update certain properties of the Network Tap Rule resource.

UPDATE azure_extras.managed_network_fabric.network_tap_rules
SET 
tags = '{{ tags }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_tap_rule_name = '{{ network_tap_rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete Network Tap Rule resource.

DELETE FROM azure_extras.managed_network_fabric.network_tap_rules
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_tap_rule_name = '{{ network_tap_rule_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

update_administrative_state

Implements the operation to the underlying resources.

EXEC azure_extras.managed_network_fabric.network_tap_rules.update_administrative_state 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_tap_rule_name='{{ network_tap_rule_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"resourceIds": "{{ resourceIds }}", 
"state": "{{ state }}"
}'
;

resync

Implements the operation to the underlying resources.

EXEC azure_extras.managed_network_fabric.network_tap_rules.resync 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_tap_rule_name='{{ network_tap_rule_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

validate_configuration

Implements the operation to the underlying resources.

EXEC azure_extras.managed_network_fabric.network_tap_rules.validate_configuration 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_tap_rule_name='{{ network_tap_rule_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;