external_networks

Creates, updates, deletes, gets or lists an external_networks resource.

Overview

Name	external_networks
Type	Resource
Id	azure.managed_network_fabric.external_networks

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	Resource properties.

list_by_l3_isolation_domain

Lists all the External Networks under the L3 Isolation Domain.

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, l3IsolationDomainName, externalNetworkName		Implements ExternalNetworks GET method.
list_by_l3_isolation_domain	select	subscriptionId, resourceGroupName, l3IsolationDomainName		Implements External Networks list by resource group GET method.
create	insert	subscriptionId, resourceGroupName, l3IsolationDomainName, externalNetworkName, data__properties		Creates ExternalNetwork PUT method.
update	update	subscriptionId, resourceGroupName, l3IsolationDomainName, externalNetworkName		API to update certain properties of the ExternalNetworks resource.
delete	delete	subscriptionId, resourceGroupName, l3IsolationDomainName, externalNetworkName		Implements ExternalNetworks 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
externalNetworkName	string	Name of the External Network.
l3IsolationDomainName	string	Name of the L3 Isolation Domain.
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

Implements ExternalNetworks GET method.

SELECT
properties
FROM azure.managed_network_fabric.external_networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND l3IsolationDomainName = '{{ l3IsolationDomainName }}' -- required
AND externalNetworkName = '{{ externalNetworkName }}' -- required
;

list_by_l3_isolation_domain

Implements External Networks list by resource group GET method.

SELECT
properties
FROM azure.managed_network_fabric.external_networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND l3IsolationDomainName = '{{ l3IsolationDomainName }}' -- required
;

INSERT examples

create

Creates ExternalNetwork PUT method.

INSERT INTO azure.managed_network_fabric.external_networks (
data__properties,
subscriptionId,
resourceGroupName,
l3IsolationDomainName,
externalNetworkName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ l3IsolationDomainName }}',
'{{ externalNetworkName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: external_networks
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the external_networks resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the external_networks resource.
    - name: l3IsolationDomainName
      value: string
      description: Required parameter for the external_networks resource.
    - name: externalNetworkName
      value: string
      description: Required parameter for the external_networks resource.
    - name: properties
      value: object
      description: |
        Resource properties.

UPDATE examples

update

API to update certain properties of the ExternalNetworks resource.

UPDATE azure.managed_network_fabric.external_networks
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND l3IsolationDomainName = '{{ l3IsolationDomainName }}' --required
AND externalNetworkName = '{{ externalNetworkName }}' --required
RETURNING
properties;

DELETE examples

delete

Implements ExternalNetworks DELETE method.

DELETE FROM azure.managed_network_fabric.external_networks
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND l3IsolationDomainName = '{{ l3IsolationDomainName }}' --required
AND externalNetworkName = '{{ externalNetworkName }}' --required
;