l2_networks

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

Overview

Name	l2_networks
Type	Resource
Id	azure.nexus.l2_networks

Fields

The following fields are returned by SELECT queries:

get

The resource has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: L2NetworkProperties represents properties of the L2 network.)
tags	object	Resource tags.

list_by_resource_group

The resource list has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: L2NetworkProperties represents properties of the L2 network.)
tags	object	Resource tags.

list_by_subscription

The resource list has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: L2NetworkProperties represents properties of the L2 network.)
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, l2NetworkName		Get properties of the provided layer 2 (L2) network.
list_by_resource_group	select	subscriptionId, resourceGroupName		Get a list of layer 2 (L2) networks in the provided resource group.
list_by_subscription	select	subscriptionId		Get a list of layer 2 (L2) networks in the provided subscription.
create_or_update	insert	subscriptionId, resourceGroupName, l2NetworkName, data__extendedLocation, data__properties		Create a new layer 2 (L2) network or update the properties of the existing network.
update	update	subscriptionId, resourceGroupName, l2NetworkName		Update tags associated with the provided layer 2 (L2) network.
delete	delete	subscriptionId, resourceGroupName, l2NetworkName		Delete the provided layer 2 (L2) network.

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
l2NetworkName	string	The name of the L2 network.
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 properties of the provided layer 2 (L2) network.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.l2_networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND l2NetworkName = '{{ l2NetworkName }}' -- required
;

list_by_resource_group

Get a list of layer 2 (L2) networks in the provided resource group.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.l2_networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Get a list of layer 2 (L2) networks in the provided subscription.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.l2_networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create a new layer 2 (L2) network or update the properties of the existing network.

INSERT INTO azure.nexus.l2_networks (
data__extendedLocation,
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
l2NetworkName
)
SELECT 
'{{ extendedLocation }}' /* required */,
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ l2NetworkName }}'
RETURNING
extendedLocation,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: l2_networks
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the l2_networks resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the l2_networks resource.
    - name: l2NetworkName
      value: string
      description: Required parameter for the l2_networks resource.
    - name: extendedLocation
      value: object
      description: |
        The extended location of the cluster associated with the resource.
    - name: properties
      value: object
      description: |
        The list of the 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 tags associated with the provided layer 2 (L2) network.

UPDATE azure.nexus.l2_networks
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND l2NetworkName = '{{ l2NetworkName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;

DELETE examples

delete

Delete the provided layer 2 (L2) network.

DELETE FROM azure.nexus.l2_networks
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND l2NetworkName = '{{ l2NetworkName }}' --required
;