virtual_networks

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

Overview

Name	virtual_networks
Type	Resource
Id	azure.network.virtual_networks

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
addressSpace	object	The AddressSpace that contains an array of IP address ranges that can be used by subnets.
bgpCommunities	object	Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET.
ddosProtectionPlan	object	Reference to another subresource.
defaultPublicNatGateway	object	Reference to another subresource.
dhcpOptions	object	The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.
enableDdosProtection	boolean	Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.
enableVmProtection	boolean	Indicates if VM protection is enabled for all the subnets in the virtual network.
encryption	object	Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the virtual network.
flowLogs	array	A collection of references to flow log resources.
flowTimeoutInMinutes	integer	The FlowTimeout value (in minutes) for the Virtual Network.
ipAllocations	array	Array of IpAllocation which reference this VNET.
location	string	Resource location.
privateEndpointVNetPolicies	string	Private Endpoint VNet Policies. Known values are: "Disabled" and "Basic". (Disabled, Basic)
provisioningState	string	The provisioning state of the virtual network resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resourceGuid property of the Virtual Network resource.
subnets	array	A list of subnets in a Virtual Network.
summarizedGatewayPrefixes	object	A configurable list of summarized gateway prefixes advertised for the virtual network.
tags	object	Resource tags.
type	string	Resource type.
virtualNetworkPeerings	array	A list of peerings in a Virtual Network.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
addressSpace	object	The AddressSpace that contains an array of IP address ranges that can be used by subnets.
bgpCommunities	object	Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET.
ddosProtectionPlan	object	Reference to another subresource.
defaultPublicNatGateway	object	Reference to another subresource.
dhcpOptions	object	The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.
enableDdosProtection	boolean	Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.
enableVmProtection	boolean	Indicates if VM protection is enabled for all the subnets in the virtual network.
encryption	object	Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the virtual network.
flowLogs	array	A collection of references to flow log resources.
flowTimeoutInMinutes	integer	The FlowTimeout value (in minutes) for the Virtual Network.
ipAllocations	array	Array of IpAllocation which reference this VNET.
location	string	Resource location.
privateEndpointVNetPolicies	string	Private Endpoint VNet Policies. Known values are: "Disabled" and "Basic". (Disabled, Basic)
provisioningState	string	The provisioning state of the virtual network resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resourceGuid property of the Virtual Network resource.
subnets	array	A list of subnets in a Virtual Network.
summarizedGatewayPrefixes	object	A configurable list of summarized gateway prefixes advertised for the virtual network.
tags	object	Resource tags.
type	string	Resource type.
virtualNetworkPeerings	array	A list of peerings in a Virtual Network.

list_all

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
addressSpace	object	The AddressSpace that contains an array of IP address ranges that can be used by subnets.
bgpCommunities	object	Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET.
ddosProtectionPlan	object	Reference to another subresource.
defaultPublicNatGateway	object	Reference to another subresource.
dhcpOptions	object	The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network.
enableDdosProtection	boolean	Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource.
enableVmProtection	boolean	Indicates if VM protection is enabled for all the subnets in the virtual network.
encryption	object	Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the virtual network.
flowLogs	array	A collection of references to flow log resources.
flowTimeoutInMinutes	integer	The FlowTimeout value (in minutes) for the Virtual Network.
ipAllocations	array	Array of IpAllocation which reference this VNET.
location	string	Resource location.
privateEndpointVNetPolicies	string	Private Endpoint VNet Policies. Known values are: "Disabled" and "Basic". (Disabled, Basic)
provisioningState	string	The provisioning state of the virtual network resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resourceGuid property of the Virtual Network resource.
subnets	array	A list of subnets in a Virtual Network.
summarizedGatewayPrefixes	object	A configurable list of summarized gateway prefixes advertised for the virtual network.
tags	object	Resource tags.
type	string	Resource type.
virtualNetworkPeerings	array	A list of peerings in a Virtual Network.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, virtual_network_name, subscription_id	$expand	Gets the specified virtual network by resource group.
list	select	resource_group_name, subscription_id		Gets all virtual networks in a resource group.
list_all	select	subscription_id		Gets all virtual networks in a subscription.
create_or_update	insert	resource_group_name, virtual_network_name, subscription_id		Creates or updates a virtual network in the specified resource group.
update_tags	update	resource_group_name, virtual_network_name, subscription_id		Updates a virtual network tags.
create_or_update	replace	resource_group_name, virtual_network_name, subscription_id		Creates or updates a virtual network in the specified resource group.
delete	delete	resource_group_name, virtual_network_name, subscription_id		Deletes the specified virtual network.
list_usage	exec	resource_group_name, virtual_network_name, subscription_id		Lists usage stats.
list_ddos_protection_status	exec	resource_group_name, virtual_network_name, subscription_id	top, skipToken	Gets the Ddos Protection Status of all IP Addresses under the Virtual Network.
check_ip_address_availability	exec	resource_group_name, virtual_network_name, subscription_id, ipAddress		Checks whether a private IP address is available for use.

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
ipAddress	string	The private IP address to be verified. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
virtual_network_name	string	The name of the virtual network. Required.
$expand	string	Expands referenced resources. Default value is None.
skipToken	string	The skipToken that is given with nextLink. Default value is None.
top	integer	The max number of ip addresses to return. Default value is None.

SELECT examples

get

Gets the specified virtual network by resource group.

SELECT
id,
name,
addressSpace,
bgpCommunities,
ddosProtectionPlan,
defaultPublicNatGateway,
dhcpOptions,
enableDdosProtection,
enableVmProtection,
encryption,
etag,
extendedLocation,
flowLogs,
flowTimeoutInMinutes,
ipAllocations,
location,
privateEndpointVNetPolicies,
provisioningState,
resourceGuid,
subnets,
summarizedGatewayPrefixes,
tags,
type,
virtualNetworkPeerings
FROM azure.network.virtual_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND virtual_network_name = '{{ virtual_network_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list

Gets all virtual networks in a resource group.

SELECT
id,
name,
addressSpace,
bgpCommunities,
ddosProtectionPlan,
defaultPublicNatGateway,
dhcpOptions,
enableDdosProtection,
enableVmProtection,
encryption,
etag,
extendedLocation,
flowLogs,
flowTimeoutInMinutes,
ipAllocations,
location,
privateEndpointVNetPolicies,
provisioningState,
resourceGuid,
subnets,
summarizedGatewayPrefixes,
tags,
type,
virtualNetworkPeerings
FROM azure.network.virtual_networks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_all

Gets all virtual networks in a subscription.

SELECT
id,
name,
addressSpace,
bgpCommunities,
ddosProtectionPlan,
defaultPublicNatGateway,
dhcpOptions,
enableDdosProtection,
enableVmProtection,
encryption,
etag,
extendedLocation,
flowLogs,
flowTimeoutInMinutes,
ipAllocations,
location,
privateEndpointVNetPolicies,
provisioningState,
resourceGuid,
subnets,
summarizedGatewayPrefixes,
tags,
type,
virtualNetworkPeerings
FROM azure.network.virtual_networks
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a virtual network in the specified resource group.

INSERT INTO azure.network.virtual_networks (
id,
location,
tags,
properties,
extendedLocation,
resource_group_name,
virtual_network_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ virtual_network_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: virtual_networks
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the virtual_networks resource.
  - name: virtual_network_name
    value: "{{ virtual_network_name }}"
    description: Required parameter for the virtual_networks resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the virtual_networks resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      Properties of the virtual network.
    value:
      addressSpace:
        addressPrefixes:
          - "{{ addressPrefixes }}"
        ipamPoolPrefixAllocations:
          - pool:
              id: "{{ id }}"
            numberOfIpAddresses: "{{ numberOfIpAddresses }}"
            allocatedAddressPrefixes: "{{ allocatedAddressPrefixes }}"
      dhcpOptions:
        dnsServers:
          - "{{ dnsServers }}"
      flowTimeoutInMinutes: {{ flowTimeoutInMinutes }}
      subnets:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            addressPrefix: "{{ addressPrefix }}"
            addressPrefixes:
              - "{{ addressPrefixes }}"
            networkSecurityGroup:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                flushConnection: {{ flushConnection }}
                securityRules: "{{ securityRules }}"
                defaultSecurityRules: "{{ defaultSecurityRules }}"
                networkInterfaces: "{{ networkInterfaces }}"
                subnets: "{{ subnets }}"
                flowLogs: "{{ flowLogs }}"
                resourceGuid: "{{ resourceGuid }}"
                provisioningState: "{{ provisioningState }}"
              etag: "{{ etag }}"
            routeTable:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                routes: "{{ routes }}"
                subnets: "{{ subnets }}"
                disableBgpRoutePropagation: {{ disableBgpRoutePropagation }}
                disablePeeringRoute: "{{ disablePeeringRoute }}"
                provisioningState: "{{ provisioningState }}"
                resourceGuid: "{{ resourceGuid }}"
              etag: "{{ etag }}"
            natGateway:
              id: "{{ id }}"
            serviceEndpoints:
              - service: "{{ service }}"
                networkIdentifier:
                  id: "{{ id }}"
                locations: "{{ locations }}"
                provisioningState: "{{ provisioningState }}"
            serviceEndpointPolicies:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                location: "{{ location }}"
                tags: "{{ tags }}"
                properties:
                  serviceEndpointPolicyDefinitions: "{{ serviceEndpointPolicyDefinitions }}"
                  subnets: "{{ subnets }}"
                  resourceGuid: "{{ resourceGuid }}"
                  provisioningState: "{{ provisioningState }}"
                  serviceAlias: "{{ serviceAlias }}"
                  contextualServiceEndpointPolicies: "{{ contextualServiceEndpointPolicies }}"
                etag: "{{ etag }}"
                kind: "{{ kind }}"
            privateEndpoints:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                location: "{{ location }}"
                tags: "{{ tags }}"
                properties:
                  subnet: "{{ subnet }}"
                  networkInterfaces: "{{ networkInterfaces }}"
                  provisioningState: "{{ provisioningState }}"
                  ipVersionType: "{{ ipVersionType }}"
                  privateLinkServiceConnections: "{{ privateLinkServiceConnections }}"
                  manualPrivateLinkServiceConnections: "{{ manualPrivateLinkServiceConnections }}"
                  customDnsConfigs: "{{ customDnsConfigs }}"
                  applicationSecurityGroups: "{{ applicationSecurityGroups }}"
                  ipConfigurations: "{{ ipConfigurations }}"
                  customNetworkInterfaceName: "{{ customNetworkInterfaceName }}"
                  billingSku: "{{ billingSku }}"
                extendedLocation:
                  name: "{{ name }}"
                  type: "{{ type }}"
                etag: "{{ etag }}"
            ipConfigurations:
              - id: "{{ id }}"
                properties:
                  privateIPAddress: "{{ privateIPAddress }}"
                  privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
                  subnet: "{{ subnet }}"
                  publicIPAddress: "{{ publicIPAddress }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
            ipConfigurationProfiles:
              - id: "{{ id }}"
                properties:
                  subnet: "{{ subnet }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                type: "{{ type }}"
                etag: "{{ etag }}"
            ipAllocations:
              - id: "{{ id }}"
            resourceNavigationLinks:
              - id: "{{ id }}"
                properties:
                  linkedResourceType: "{{ linkedResourceType }}"
                  link: "{{ link }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
                type: "{{ type }}"
            serviceAssociationLinks:
              - id: "{{ id }}"
                properties:
                  linkedResourceType: "{{ linkedResourceType }}"
                  link: "{{ link }}"
                  provisioningState: "{{ provisioningState }}"
                  allowDelete: {{ allowDelete }}
                  locations: "{{ locations }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
                type: "{{ type }}"
            delegations:
              - id: "{{ id }}"
                properties:
                  serviceName: "{{ serviceName }}"
                  actions: "{{ actions }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
                type: "{{ type }}"
            purpose: "{{ purpose }}"
            provisioningState: "{{ provisioningState }}"
            privateEndpointNetworkPolicies: "{{ privateEndpointNetworkPolicies }}"
            privateLinkServiceNetworkPolicies: "{{ privateLinkServiceNetworkPolicies }}"
            applicationGatewayIPConfigurations:
              - id: "{{ id }}"
                properties:
                  subnet: "{{ subnet }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
                type: "{{ type }}"
            sharingScope: "{{ sharingScope }}"
            defaultOutboundAccess: {{ defaultOutboundAccess }}
            ipamPoolPrefixAllocations:
              - pool:
                  id: "{{ id }}"
                numberOfIpAddresses: "{{ numberOfIpAddresses }}"
                allocatedAddressPrefixes: "{{ allocatedAddressPrefixes }}"
            serviceGateway:
              id: "{{ id }}"
          etag: "{{ etag }}"
      virtualNetworkPeerings:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            allowVirtualNetworkAccess: {{ allowVirtualNetworkAccess }}
            allowForwardedTraffic: {{ allowForwardedTraffic }}
            allowGatewayTransit: {{ allowGatewayTransit }}
            useRemoteGateways: {{ useRemoteGateways }}
            remoteVirtualNetwork:
              id: "{{ id }}"
            localAddressSpace:
              addressPrefixes:
                - "{{ addressPrefixes }}"
              ipamPoolPrefixAllocations:
                - pool:
                    id: "{{ id }}"
                  numberOfIpAddresses: "{{ numberOfIpAddresses }}"
                  allocatedAddressPrefixes: "{{ allocatedAddressPrefixes }}"
            localVirtualNetworkAddressSpace:
              addressPrefixes:
                - "{{ addressPrefixes }}"
              ipamPoolPrefixAllocations:
                - pool:
                    id: "{{ id }}"
                  numberOfIpAddresses: "{{ numberOfIpAddresses }}"
                  allocatedAddressPrefixes: "{{ allocatedAddressPrefixes }}"
            remoteAddressSpace:
              addressPrefixes:
                - "{{ addressPrefixes }}"
              ipamPoolPrefixAllocations:
                - pool:
                    id: "{{ id }}"
                  numberOfIpAddresses: "{{ numberOfIpAddresses }}"
                  allocatedAddressPrefixes: "{{ allocatedAddressPrefixes }}"
            remoteVirtualNetworkAddressSpace:
              addressPrefixes:
                - "{{ addressPrefixes }}"
              ipamPoolPrefixAllocations:
                - pool:
                    id: "{{ id }}"
                  numberOfIpAddresses: "{{ numberOfIpAddresses }}"
                  allocatedAddressPrefixes: "{{ allocatedAddressPrefixes }}"
            remoteBgpCommunities:
              virtualNetworkCommunity: "{{ virtualNetworkCommunity }}"
              regionalCommunity: "{{ regionalCommunity }}"
            remoteVirtualNetworkEncryption:
              enabled: {{ enabled }}
              enforcement: "{{ enforcement }}"
            peeringState: "{{ peeringState }}"
            peeringSyncLevel: "{{ peeringSyncLevel }}"
            provisioningState: "{{ provisioningState }}"
            doNotVerifyRemoteGateways: {{ doNotVerifyRemoteGateways }}
            resourceGuid: "{{ resourceGuid }}"
            peerCompleteVnets: {{ peerCompleteVnets }}
            enableOnlyIPv6Peering: {{ enableOnlyIPv6Peering }}
            localSubnetNames:
              - "{{ localSubnetNames }}"
            remoteSubnetNames:
              - "{{ remoteSubnetNames }}"
          etag: "{{ etag }}"
      resourceGuid: "{{ resourceGuid }}"
      provisioningState: "{{ provisioningState }}"
      enableDdosProtection: {{ enableDdosProtection }}
      enableVmProtection: {{ enableVmProtection }}
      ddosProtectionPlan:
        id: "{{ id }}"
      bgpCommunities:
        virtualNetworkCommunity: "{{ virtualNetworkCommunity }}"
        regionalCommunity: "{{ regionalCommunity }}"
      encryption:
        enabled: {{ enabled }}
        enforcement: "{{ enforcement }}"
      ipAllocations:
        - id: "{{ id }}"
      flowLogs:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          location: "{{ location }}"
          tags: "{{ tags }}"
          properties:
            targetResourceId: "{{ targetResourceId }}"
            targetResourceGuid: "{{ targetResourceGuid }}"
            storageId: "{{ storageId }}"
            enabledFilteringCriteria: "{{ enabledFilteringCriteria }}"
            recordTypes: "{{ recordTypes }}"
            enabled: {{ enabled }}
            retentionPolicy:
              days: {{ days }}
              enabled: {{ enabled }}
            format:
              type: "{{ type }}"
              version: {{ version }}
            flowAnalyticsConfiguration:
              networkWatcherFlowAnalyticsConfiguration:
                enabled: {{ enabled }}
                workspaceId: "{{ workspaceId }}"
                workspaceRegion: "{{ workspaceRegion }}"
                workspaceResourceId: "{{ workspaceResourceId }}"
                trafficAnalyticsInterval: {{ trafficAnalyticsInterval }}
            provisioningState: "{{ provisioningState }}"
          etag: "{{ etag }}"
          identity:
            principalId: "{{ principalId }}"
            tenantId: "{{ tenantId }}"
            type: "{{ type }}"
            userAssignedIdentities: "{{ userAssignedIdentities }}"
      privateEndpointVNetPolicies: "{{ privateEndpointVNetPolicies }}"
      defaultPublicNatGateway:
        id: "{{ id }}"
      summarizedGatewayPrefixes:
        addressPrefixes:
          - "{{ addressPrefixes }}"
        ipamPoolPrefixAllocations:
          - pool:
              id: "{{ id }}"
            numberOfIpAddresses: "{{ numberOfIpAddresses }}"
            allocatedAddressPrefixes: "{{ allocatedAddressPrefixes }}"
  - name: extendedLocation
    description: |
      The extended location of the virtual network.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

UPDATE examples

update_tags

Updates a virtual network tags.

UPDATE azure.network.virtual_networks
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_network_name = '{{ virtual_network_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a virtual network in the specified resource group.

REPLACE azure.network.virtual_networks
SET 
id = '{{ id }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND virtual_network_name = '{{ virtual_network_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes the specified virtual network.

DELETE FROM azure.network.virtual_networks
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND virtual_network_name = '{{ virtual_network_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_usage

Lists usage stats.

EXEC azure.network.virtual_networks.list_usage 
@resource_group_name='{{ resource_group_name }}' --required, 
@virtual_network_name='{{ virtual_network_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_ddos_protection_status

Gets the Ddos Protection Status of all IP Addresses under the Virtual Network.

EXEC azure.network.virtual_networks.list_ddos_protection_status 
@resource_group_name='{{ resource_group_name }}' --required, 
@virtual_network_name='{{ virtual_network_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@top='{{ top }}', 
@skipToken='{{ skipToken }}'
;

check_ip_address_availability

Checks whether a private IP address is available for use.

EXEC azure.network.virtual_networks.check_ip_address_availability 
@resource_group_name='{{ resource_group_name }}' --required, 
@virtual_network_name='{{ virtual_network_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@ipAddress='{{ ipAddress }}' --required
;