logical_networks

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

Overview

Name	logical_networks
Type	Resource
Id	azure_stack.azure_stack_hci_vm.logical_networks

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.
dhcpOptions	object	DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options.
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives. Required.
networkType	string	Type of the Logical Network. Known values are: "Workload" and "Infrastructure". (Workload, Infrastructure)
provisioningState	string	Provisioning state of the logical network. Known values are: "Succeeded", "Failed", "InProgress", "Accepted", "Deleting", and "Canceled". (Succeeded, Failed, InProgress, Accepted, Deleting, Canceled)
status	object	The observed state of logical networks.
subnets	array	Subnet - list of subnets under the logical network.
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".
vmSwitchName	string	name of the network switch to be used for VMs.

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.
dhcpOptions	object	DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options.
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives. Required.
networkType	string	Type of the Logical Network. Known values are: "Workload" and "Infrastructure". (Workload, Infrastructure)
provisioningState	string	Provisioning state of the logical network. Known values are: "Succeeded", "Failed", "InProgress", "Accepted", "Deleting", and "Canceled". (Succeeded, Failed, InProgress, Accepted, Deleting, Canceled)
status	object	The observed state of logical networks.
subnets	array	Subnet - list of subnets under the logical network.
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".
vmSwitchName	string	name of the network switch to be used for VMs.

list_all

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.
dhcpOptions	object	DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options.
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives. Required.
networkType	string	Type of the Logical Network. Known values are: "Workload" and "Infrastructure". (Workload, Infrastructure)
provisioningState	string	Provisioning state of the logical network. Known values are: "Succeeded", "Failed", "InProgress", "Accepted", "Deleting", and "Canceled". (Succeeded, Failed, InProgress, Accepted, Deleting, Canceled)
status	object	The observed state of logical networks.
subnets	array	Subnet - list of subnets under the logical network.
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".
vmSwitchName	string	name of the network switch to be used for VMs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, logical_network_name, subscription_id		The operation to get a logical network.
list_by_resource_group	select	resource_group_name, subscription_id		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	subscription_id		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	resource_group_name, logical_network_name, subscription_id, location		The operation to create or update a logical network. Please note some properties can be set only during logical network creation.
update	update	resource_group_name, logical_network_name, subscription_id		The operation to update a logical network.
create_or_update	replace	resource_group_name, logical_network_name, subscription_id, location		The operation to create or update a logical network. Please note some properties can be set only during logical network creation.
delete	delete	resource_group_name, logical_network_name, subscription_id		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
logical_network_name	string	Name of the logical network. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

The operation to get a logical network.

SELECT
id,
name,
dhcpOptions,
extendedLocation,
location,
networkType,
provisioningState,
status,
subnets,
systemData,
tags,
type,
vmSwitchName
FROM azure_stack.azure_stack_hci_vm.logical_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND logical_network_name = '{{ logical_network_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

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
id,
name,
dhcpOptions,
extendedLocation,
location,
networkType,
provisioningState,
status,
subnets,
systemData,
tags,
type,
vmSwitchName
FROM azure_stack.azure_stack_hci_vm.logical_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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
id,
name,
dhcpOptions,
extendedLocation,
location,
networkType,
provisioningState,
status,
subnets,
systemData,
tags,
type,
vmSwitchName
FROM azure_stack.azure_stack_hci_vm.logical_networks
WHERE subscription_id = '{{ subscription_id }}' -- 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_vm.logical_networks (
tags,
location,
properties,
extendedLocation,
resource_group_name,
logical_network_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ logical_network_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: logical_networks
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the logical_networks resource.
  - name: logical_network_name
    value: "{{ logical_network_name }}"
    description: Required parameter for the logical_networks resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the logical_networks 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 resource-specific properties for this resource.
    value:
      dhcpOptions:
        dnsServers:
          - "{{ dnsServers }}"
      subnets:
        - properties:
            addressPrefix: "{{ addressPrefix }}"
            addressPrefixes:
              - "{{ addressPrefixes }}"
            ipAllocationMethod: "{{ ipAllocationMethod }}"
            ipConfigurationReferences:
              - ID: "{{ ID }}"
            networkSecurityGroup:
              id: "{{ id }}"
            routeTable:
              etag: "{{ etag }}"
              name: "{{ name }}"
              type: "{{ type }}"
              properties:
                routes: "{{ routes }}"
            ipPools:
              - name: "{{ name }}"
                ipPoolType: "{{ ipPoolType }}"
                start: "{{ start }}"
                end: "{{ end }}"
                info:
                  used: "{{ used }}"
                  available: "{{ available }}"
            vlan: {{ vlan }}
          name: "{{ name }}"
      provisioningState: "{{ provisioningState }}"
      vmSwitchName: "{{ vmSwitchName }}"
      status:
        errorCode: "{{ errorCode }}"
        errorMessage: "{{ errorMessage }}"
        provisioningStatus:
          operationId: "{{ operationId }}"
          status: "{{ status }}"
      networkType: "{{ networkType }}"
  - name: extendedLocation
    description: |
      The extendedLocation of the resource.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

UPDATE examples

update

The operation to update a logical network.

UPDATE azure_stack.azure_stack_hci_vm.logical_networks
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND logical_network_name = '{{ logical_network_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type;

REPLACE 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.

REPLACE azure_stack.azure_stack_hci_vm.logical_networks
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND logical_network_name = '{{ logical_network_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

The operation to delete a logical network.

DELETE FROM azure_stack.azure_stack_hci_vm.logical_networks
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND logical_network_name = '{{ logical_network_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;