neighbor_groups

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

Overview

Name	neighbor_groups
Type	Resource
Id	azure.managed_network_fabric.neighbor_groups

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 Neighbor Groups 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 Neighbor Groups 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, neighborGroupName		Gets the Neighbor Group.
list_by_resource_group	select	subscriptionId, resourceGroupName		Displays NeighborGroups list by resource group GET method.
list_by_subscription	select	subscriptionId		Displays NeighborGroups list by subscription GET method.
create	insert	subscriptionId, resourceGroupName, neighborGroupName, data__properties		Implements the Neighbor Group PUT method.
update	update	subscriptionId, resourceGroupName, neighborGroupName		Updates the Neighbor Group.
delete	delete	subscriptionId, resourceGroupName, neighborGroupName		Implements Neighbor Group DELETE method.

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
neighborGroupName	string	Name of the Neighbor Group.
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

Gets the Neighbor Group.

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

list_by_resource_group

Displays NeighborGroups list by resource group GET method.

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

list_by_subscription

Displays NeighborGroups list by subscription GET method.

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

INSERT examples

create

Implements the Neighbor Group PUT method.

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

Manifest

# Description fields are for documentation purposes
- name: neighbor_groups
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the neighbor_groups resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the neighbor_groups resource.
    - name: neighborGroupName
      value: string
      description: Required parameter for the neighbor_groups resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Resource properties.

UPDATE examples

update

Updates the Neighbor Group.

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

DELETE examples

delete

Implements Neighbor Group DELETE method.

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