network_taps

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

Overview

Name	network_taps
Type	Resource
Id	azure_extras.managed_network_fabric.network_taps

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. Example -Enabled/Disabled. Known values are: "Enabled", "Disabled", "MAT", "RMA", "UnderMaintenance", and "EnabledDegraded". (Enabled, Disabled, MAT, RMA, UnderMaintenance, EnabledDegraded)
annotation	string	Switch configuration description.
configurationState	string	Gets the configurations 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)
destinations	array	List of destinations to send the filter traffic. Required.
identity	object	The managed service identities assigned to this resource.
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
networkFabricIds	array	Associated Network Fabric Resource IDs.
networkPacketBrokerId	string	ARM resource ID of the Network Packet Broker. Required.
pollingType	string	Polling type. Known values are: "Pull" and "Push". (Pull, Push)
provisioningState	string	Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of Network Tap provisioning. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
sourceTapRuleId	string	Source Tap Rule Id. ARM Resource ID of the Network Tap Rule.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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. Example -Enabled/Disabled. Known values are: "Enabled", "Disabled", "MAT", "RMA", "UnderMaintenance", and "EnabledDegraded". (Enabled, Disabled, MAT, RMA, UnderMaintenance, EnabledDegraded)
annotation	string	Switch configuration description.
configurationState	string	Gets the configurations 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)
destinations	array	List of destinations to send the filter traffic. Required.
identity	object	The managed service identities assigned to this resource.
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
networkFabricIds	array	Associated Network Fabric Resource IDs.
networkPacketBrokerId	string	ARM resource ID of the Network Packet Broker. Required.
pollingType	string	Polling type. Known values are: "Pull" and "Push". (Pull, Push)
provisioningState	string	Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of Network Tap provisioning. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
sourceTapRuleId	string	Source Tap Rule Id. ARM Resource ID of the Network Tap Rule.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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. Example -Enabled/Disabled. Known values are: "Enabled", "Disabled", "MAT", "RMA", "UnderMaintenance", and "EnabledDegraded". (Enabled, Disabled, MAT, RMA, UnderMaintenance, EnabledDegraded)
annotation	string	Switch configuration description.
configurationState	string	Gets the configurations 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)
destinations	array	List of destinations to send the filter traffic. Required.
identity	object	The managed service identities assigned to this resource.
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
networkFabricIds	array	Associated Network Fabric Resource IDs.
networkPacketBrokerId	string	ARM resource ID of the Network Packet Broker. Required.
pollingType	string	Polling type. Known values are: "Pull" and "Push". (Pull, Push)
provisioningState	string	Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of Network Tap provisioning. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
sourceTapRuleId	string	Source Tap Rule Id. ARM Resource ID of the Network Tap Rule.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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_name, subscription_id		Retrieves details of this Network Tap.
list_by_resource_group	select	resource_group_name, subscription_id		Displays Network Taps list by resource group GET method.
list_by_subscription	select	subscription_id		Displays Network Taps list by subscription GET method.
create	insert	resource_group_name, network_tap_name, subscription_id, location, properties		Creates a Network Tap.
update	update	resource_group_name, network_tap_name, subscription_id		API to update certain properties of the Network Tap resource.
delete	delete	resource_group_name, network_tap_name, subscription_id		Deletes Network Tap.
update_administrative_state	exec	resource_group_name, network_tap_name, subscription_id		Implements the operation to the underlying resources.
resync	exec	resource_group_name, network_tap_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_name	string	Name of the Network Tap. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Retrieves details of this Network Tap.

SELECT
id,
name,
administrativeState,
annotation,
configurationState,
destinations,
identity,
lastOperation,
location,
networkFabricIds,
networkPacketBrokerId,
pollingType,
provisioningState,
sourceTapRuleId,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.network_taps
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_tap_name = '{{ network_tap_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Displays Network Taps list by resource group GET method.

SELECT
id,
name,
administrativeState,
annotation,
configurationState,
destinations,
identity,
lastOperation,
location,
networkFabricIds,
networkPacketBrokerId,
pollingType,
provisioningState,
sourceTapRuleId,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.network_taps
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Displays Network Taps list by subscription GET method.

SELECT
id,
name,
administrativeState,
annotation,
configurationState,
destinations,
identity,
lastOperation,
location,
networkFabricIds,
networkPacketBrokerId,
pollingType,
provisioningState,
sourceTapRuleId,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.network_taps
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a Network Tap.

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

Manifest

# Description fields are for documentation purposes
- name: network_taps
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_taps resource.
  - name: network_tap_name
    value: "{{ network_tap_name }}"
    description: Required parameter for the network_taps resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_taps 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 NetworkTap Properties. Required.
    value:
      annotation: "{{ annotation }}"
      networkPacketBrokerId: "{{ networkPacketBrokerId }}"
      sourceTapRuleId: "{{ sourceTapRuleId }}"
      networkFabricIds:
        - "{{ networkFabricIds }}"
      destinations:
        - name: "{{ name }}"
          destinationType: "{{ destinationType }}"
          destinationId: "{{ destinationId }}"
          isolationDomainProperties:
            encapsulation: "{{ encapsulation }}"
            neighborGroupIds:
              - "{{ neighborGroupIds }}"
          destinationTapRuleId: "{{ destinationTapRuleId }}"
      pollingType: "{{ pollingType }}"
      lastOperation:
        details: "{{ details }}"
      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

API to update certain properties of the Network Tap resource.

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

DELETE examples

delete

Deletes Network Tap.

DELETE FROM azure_extras.managed_network_fabric.network_taps
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_tap_name = '{{ network_tap_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_taps.update_administrative_state 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_tap_name='{{ network_tap_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_taps.resync 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_tap_name='{{ network_tap_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;