network_packet_brokers

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

Overview

Name	network_packet_brokers
Type	Resource
Id	azure.managed_network_fabric.network_packet_brokers

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 Packet Brokers 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 NetworkPacketBrokers 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, networkPacketBrokerName		Retrieves details of this Network Packet Broker.
list_by_resource_group	select	subscriptionId, resourceGroupName		Displays NetworkPacketBrokers list by resource group GET method.
list_by_subscription	select	subscriptionId		Displays Network Packet Brokers list by subscription GET method.
create	insert	subscriptionId, resourceGroupName, networkPacketBrokerName, data__properties		Creates a Network Packet Broker.
update	update	subscriptionId, resourceGroupName, networkPacketBrokerName		API to update certain properties of the Network Packet Broker resource.
delete	delete	subscriptionId, resourceGroupName, networkPacketBrokerName		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
networkPacketBrokerName	string	Name of the Network Packet Broker.
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 Packet Broker.

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

list_by_resource_group

Displays NetworkPacketBrokers list by resource group GET method.

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

list_by_subscription

Displays Network Packet Brokers list by subscription GET method.

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

INSERT examples

create

Creates a Network Packet Broker.

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

Manifest

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

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

DELETE examples

delete

Deletes Network Packet Broker.

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