network_packet_brokers

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

Overview

Name	network_packet_brokers
Type	Resource
Id	azure_extras.managed_network_fabric.network_packet_brokers

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.
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)
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.
neighborGroupIds	array	List of neighbor group IDs configured on NPB.
networkDeviceIds	array	List of ARM resource IDs of Network Devices [NPB].
networkFabricId	string	ARM resource ID of the Network Fabric. Required.
networkTapIds	array	List of network Tap IDs configured on NPB.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
sourceInterfaceIds	array	List of network interfaces across NPB devices that are used to mirror source traffic.
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.
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)
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.
neighborGroupIds	array	List of neighbor group IDs configured on NPB.
networkDeviceIds	array	List of ARM resource IDs of Network Devices [NPB].
networkFabricId	string	ARM resource ID of the Network Fabric. Required.
networkTapIds	array	List of network Tap IDs configured on NPB.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
sourceInterfaceIds	array	List of network interfaces across NPB devices that are used to mirror source traffic.
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.
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)
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.
neighborGroupIds	array	List of neighbor group IDs configured on NPB.
networkDeviceIds	array	List of ARM resource IDs of Network Devices [NPB].
networkFabricId	string	ARM resource ID of the Network Fabric. Required.
networkTapIds	array	List of network Tap IDs configured on NPB.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
sourceInterfaceIds	array	List of network interfaces across NPB devices that are used to mirror source traffic.
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_packet_broker_name, subscription_id		Retrieves details of this Network Packet Broker.
list_by_resource_group	select	resource_group_name, subscription_id		Displays NetworkPacketBrokers list by resource group GET method.
list_by_subscription	select	subscription_id		Displays Network Packet Brokers list by subscription GET method.
create	insert	resource_group_name, network_packet_broker_name, subscription_id, location, properties		Creates a Network Packet Broker.
update	update	resource_group_name, network_packet_broker_name, subscription_id		API to update certain properties of the Network Packet Broker resource.
delete	delete	resource_group_name, network_packet_broker_name, subscription_id		Deletes Network Packet Broker.

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_packet_broker_name	string	Name of the Network Packet Broker. 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 Packet Broker.

SELECT
id,
name,
configurationState,
identity,
lastOperation,
location,
neighborGroupIds,
networkDeviceIds,
networkFabricId,
networkTapIds,
provisioningState,
sourceInterfaceIds,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.network_packet_brokers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_packet_broker_name = '{{ network_packet_broker_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Displays NetworkPacketBrokers list by resource group GET method.

SELECT
id,
name,
configurationState,
identity,
lastOperation,
location,
neighborGroupIds,
networkDeviceIds,
networkFabricId,
networkTapIds,
provisioningState,
sourceInterfaceIds,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.network_packet_brokers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Displays Network Packet Brokers list by subscription GET method.

SELECT
id,
name,
configurationState,
identity,
lastOperation,
location,
neighborGroupIds,
networkDeviceIds,
networkFabricId,
networkTapIds,
provisioningState,
sourceInterfaceIds,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.network_packet_brokers
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a Network Packet Broker.

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

Manifest

# Description fields are for documentation purposes
- name: network_packet_brokers
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_packet_brokers resource.
  - name: network_packet_broker_name
    value: "{{ network_packet_broker_name }}"
    description: Required parameter for the network_packet_brokers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_packet_brokers 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 NetworkPacketBroker properties. Required.
    value:
      networkFabricId: "{{ networkFabricId }}"
      networkDeviceIds:
        - "{{ networkDeviceIds }}"
      sourceInterfaceIds:
        - "{{ sourceInterfaceIds }}"
      networkTapIds:
        - "{{ networkTapIds }}"
      neighborGroupIds:
        - "{{ neighborGroupIds }}"
      lastOperation:
        details: "{{ details }}"
      provisioningState: "{{ provisioningState }}"
      configurationState: "{{ configurationState }}"
  - 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 Packet Broker resource.

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

DELETE examples

delete

Deletes Network Packet Broker.

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