logical_networks

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

Overview

Name	logical_networks
Type	Resource
Id	azure_stack.azure_stack_hci.logical_networks

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives
properties	object	Properties under the logical network resource
tags	object	Resource tags.

list

Name	Datatype	Description
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives
properties	object	Properties under the logical network resource
tags	object	Resource tags.

list_all

Name	Datatype	Description
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives
properties	object	Properties under the logical network resource
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, logicalNetworkName
list	select	subscriptionId, resourceGroupName		Lists all of the logical networks in the specified resource group. Use the nextLink property in the response to get the next page of logical networks.
list_all	select	subscriptionId		Lists all of the logical networks in the specified subscription. Use the nextLink property in the response to get the next page of logical networks.
create_or_update	insert	subscriptionId, resourceGroupName, logicalNetworkName		The operation to create or update a logical network. Please note some properties can be set only during logical network creation.
update	update	subscriptionId, resourceGroupName, logicalNetworkName		The operation to update a logical network.
delete	delete	subscriptionId, resourceGroupName, logicalNetworkName		The operation to delete a logical 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
logicalNetworkName	string	Name of the logical 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

OK

SELECT
extendedLocation,
location,
properties,
tags
FROM azure_stack.azure_stack_hci.logical_networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND logicalNetworkName = '{{ logicalNetworkName }}' -- required
;

list

Lists all of the logical networks in the specified resource group. Use the nextLink property in the response to get the next page of logical networks.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure_stack.azure_stack_hci.logical_networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_all

Lists all of the logical networks in the specified subscription. Use the nextLink property in the response to get the next page of logical networks.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure_stack.azure_stack_hci.logical_networks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

The operation to create or update a logical network. Please note some properties can be set only during logical network creation.

INSERT INTO azure_stack.azure_stack_hci.logical_networks (
data__properties,
data__extendedLocation,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
logicalNetworkName
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ logicalNetworkName }}'
RETURNING
extendedLocation,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: logical_networks
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the logical_networks resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the logical_networks resource.
    - name: logicalNetworkName
      value: string
      description: Required parameter for the logical_networks resource.
    - name: properties
      value: object
      description: |
        Properties under the logical network resource
    - name: extendedLocation
      value: object
      description: |
        The extendedLocation of the resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

The operation to update a logical network.

UPDATE azure_stack.azure_stack_hci.logical_networks
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND logicalNetworkName = '{{ logicalNetworkName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;

DELETE examples

delete

The operation to delete a logical network.

DELETE FROM azure_stack.azure_stack_hci.logical_networks
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND logicalNetworkName = '{{ logicalNetworkName }}' --required
;