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

vw_logical_networks

Name	Datatype	Description
dhcp_options	text	field from the properties object
extended_location	text	field from the properties object
location	text	The geo-location where the resource lives
logicalNetworkName	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
status	text	field from the properties object
subnets	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
vm_switch_name	text	field from the properties object

logical_networks

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

Methods

Name	Accessible by	Required Params	Description
get	SELECT	logicalNetworkName, resourceGroupName, subscriptionId
list	SELECT	resourceGroupName, subscriptionId	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	logicalNetworkName, resourceGroupName, subscriptionId	The operation to create or update a logical network. Please note some properties can be set only during logical network creation.
delete	DELETE	logicalNetworkName, resourceGroupName, subscriptionId	The operation to delete a logical network.
update	UPDATE	logicalNetworkName, resourceGroupName, subscriptionId	The operation to update a logical network.

SELECT examples

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.

vw_logical_networks

SELECT
dhcp_options,
extended_location,
location,
logicalNetworkName,
provisioning_state,
resourceGroupName,
status,
subnets,
subscriptionId,
tags,
vm_switch_name
FROM azure_stack.azure_stack_hci.vw_logical_networks
WHERE subscriptionId = '{{ subscriptionId }}';

logical_networks

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

INSERT example

Use the following StackQL query and manifest file to create a new logical_networks resource.

All Properties

/*+ create */
INSERT INTO azure_stack.azure_stack_hci.logical_networks (
logicalNetworkName,
resourceGroupName,
subscriptionId,
properties,
extendedLocation,
tags,
location
)
SELECT 
'{{ logicalNetworkName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ extendedLocation }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: dhcpOptions
          value:
            - name: dnsServers
              value:
                - string
        - name: subnets
          value:
            - - name: properties
                value:
                  - name: addressPrefix
                    value: string
                  - name: addressPrefixes
                    value:
                      - string
                  - name: ipAllocationMethod
                    value: string
                  - name: ipConfigurationReferences
                    value:
                      - - name: ID
                          value: string
                  - name: routeTable
                    value:
                      - name: etag
                        value: string
                      - name: name
                        value: string
                      - name: type
                        value: string
                      - name: properties
                        value:
                          - name: routes
                            value:
                              - - name: properties
                                  value:
                                    - name: addressPrefix
                                      value: string
                                    - name: nextHopIpAddress
                                      value: string
                                - name: name
                                  value: string
                  - name: ipPools
                    value:
                      - - name: name
                          value: string
                        - name: ipPoolType
                          value: string
                        - name: start
                          value: string
                        - name: end
                          value: string
                        - name: info
                          value:
                            - name: used
                              value: string
                            - name: available
                              value: string
                  - name: vlan
                    value: integer
              - name: name
                value: string
        - name: provisioningState
          value: string
        - name: vmSwitchName
          value: string
        - name: status
          value:
            - name: errorCode
              value: string
            - name: errorMessage
              value: string
            - name: provisioningStatus
              value:
                - name: operationId
                  value: string
                - name: status
                  value: string
    - name: extendedLocation
      value:
        - name: name
          value: string
        - name: type
          value: []
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a logical_networks resource.

/*+ update */
UPDATE azure_stack.azure_stack_hci.logical_networks
SET 
tags = '{{ tags }}'
WHERE 
logicalNetworkName = '{{ logicalNetworkName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified logical_networks resource.

/*+ delete */
DELETE FROM azure_stack.azure_stack_hci.logical_networks
WHERE logicalNetworkName = '{{ logicalNetworkName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';