neighbor_groups

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

Overview

Name	neighbor_groups
Type	Resource
Id	azure_extras.managed_network_fabric.neighbor_groups

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.
annotation	string	Switch configuration description.
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)
destination	object	An array of destination IPv4 Addresses or IPv6 Addresses. 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.
networkTapIds	array	List of NetworkTap IDs where neighbor group is associated.
networkTapRuleIds	array	List of Network Tap Rule IDs where neighbor group is associated.
provisioningState	string	The provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
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.
annotation	string	Switch configuration description.
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)
destination	object	An array of destination IPv4 Addresses or IPv6 Addresses. 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.
networkTapIds	array	List of NetworkTap IDs where neighbor group is associated.
networkTapRuleIds	array	List of Network Tap Rule IDs where neighbor group is associated.
provisioningState	string	The provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
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.
annotation	string	Switch configuration description.
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)
destination	object	An array of destination IPv4 Addresses or IPv6 Addresses. 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.
networkTapIds	array	List of NetworkTap IDs where neighbor group is associated.
networkTapRuleIds	array	List of Network Tap Rule IDs where neighbor group is associated.
provisioningState	string	The provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
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, neighbor_group_name, subscription_id		Gets the Neighbor Group.
list_by_resource_group	select	resource_group_name, subscription_id		Displays NeighborGroups list by resource group GET method.
list_by_subscription	select	subscription_id		Displays NeighborGroups list by subscription GET method.
create	insert	resource_group_name, neighbor_group_name, subscription_id, location, properties		Implements the Neighbor Group PUT method.
update	update	resource_group_name, neighbor_group_name, subscription_id		Updates the Neighbor Group.
delete	delete	resource_group_name, neighbor_group_name, subscription_id		Implements Neighbor Group DELETE method.
resync	exec	resource_group_name, neighbor_group_name, subscription_id		Resync the Neighbor Group after a configuration change.

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
neighbor_group_name	string	Name of the Neighbor Group. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the Neighbor Group.

SELECT
id,
name,
annotation,
configurationState,
destination,
identity,
lastOperation,
location,
networkFabricIds,
networkTapIds,
networkTapRuleIds,
provisioningState,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.neighbor_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND neighbor_group_name = '{{ neighbor_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Displays NeighborGroups list by resource group GET method.

SELECT
id,
name,
annotation,
configurationState,
destination,
identity,
lastOperation,
location,
networkFabricIds,
networkTapIds,
networkTapRuleIds,
provisioningState,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.neighbor_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Displays NeighborGroups list by subscription GET method.

SELECT
id,
name,
annotation,
configurationState,
destination,
identity,
lastOperation,
location,
networkFabricIds,
networkTapIds,
networkTapRuleIds,
provisioningState,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.neighbor_groups
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Implements the Neighbor Group PUT method.

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

Manifest

# Description fields are for documentation purposes
- name: neighbor_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the neighbor_groups resource.
  - name: neighbor_group_name
    value: "{{ neighbor_group_name }}"
    description: Required parameter for the neighbor_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the neighbor_groups 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 NeighborGroup Properties. Required.
    value:
      annotation: "{{ annotation }}"
      destination:
        ipv4Addresses:
          - "{{ ipv4Addresses }}"
        ipv6Addresses:
          - "{{ ipv6Addresses }}"
      networkTapIds:
        - "{{ networkTapIds }}"
      networkTapRuleIds:
        - "{{ networkTapRuleIds }}"
      networkFabricIds:
        - "{{ networkFabricIds }}"
      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

Updates the Neighbor Group.

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

DELETE examples

delete

Implements Neighbor Group DELETE method.

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

Lifecycle Methods

resync

Resync the Neighbor Group after a configuration change.

EXEC azure_extras.managed_network_fabric.neighbor_groups.resync 
@resource_group_name='{{ resource_group_name }}' --required, 
@neighbor_group_name='{{ neighbor_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;