Add-AzVirtualNetworkSubnetConfig

Module:

Az.Network Module

Adds a subnet configuration to a virtual network.

Add-AzVirtualNetworkSubnetConfig
 -Name <String>
 -VirtualNetwork <PSVirtualNetwork>
 [-AddressPrefix <String[]>]
 [-IpamPoolPrefixAllocation <PSIpamPoolPrefixAllocation[]>]
 [-NetworkSecurityGroup <PSNetworkSecurityGroup>]
 [-RouteTable <PSRouteTable>]
 [-InputObject <PSNatGateway>]
 [-ServiceEndpoint <String[]>]
 [-NetworkIdentifier <PSResourceId>]
 [-ServiceEndpointConfig <PSServiceEndpoint[]>]
 [-ServiceEndpointPolicy <PSServiceEndpointPolicy[]>]
 [-Delegation <PSDelegation[]>]
 [-PrivateEndpointNetworkPoliciesFlag <String>]
 [-PrivateLinkServiceNetworkPoliciesFlag <String>]
 [-IpAllocation <PSIpAllocation[]>]
 [-DefaultOutboundAccess <Boolean>]
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

Add-AzVirtualNetworkSubnetConfig
 -Name <String>
 -VirtualNetwork <PSVirtualNetwork>
 [-AddressPrefix <String[]>]
 [-IpamPoolPrefixAllocation <PSIpamPoolPrefixAllocation[]>]
 [-NetworkSecurityGroupId <String>]
 [-RouteTableId <String>]
 [-ResourceId <String>]
 [-ServiceEndpoint <String[]>]
 [-NetworkIdentifier <PSResourceId>]
 [-ServiceEndpointConfig <PSServiceEndpoint[]>]
 [-ServiceEndpointPolicy <PSServiceEndpointPolicy[]>]
 [-Delegation <PSDelegation[]>]
 [-PrivateEndpointNetworkPoliciesFlag <String>]
 [-PrivateLinkServiceNetworkPoliciesFlag <String>]
 [-IpAllocation <PSIpAllocation[]>]
 [-DefaultOutboundAccess <Boolean>]
 [-DefaultProfile <IAzureContextContainer>]
 [<CommonParameters>]

The Add-AzVirtualNetworkSubnetConfig cmdlet adds a subnet configuration to an existing Azure virtual network.

New-AzResourceGroup -Name TestResourceGroup -Location centralus
 $frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24"
 $virtualNetwork = New-AzVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -Location centralus -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet
 Add-AzVirtualNetworkSubnetConfig -Name backendSubnet -VirtualNetwork $virtualNetwork -AddressPrefix "10.0.2.0/24"
 $virtualNetwork | Set-AzVirtualNetwork

This example first creates a resource group as a container of the resources to be created. It then creates a subnet configuration and uses it to create a virtual network. The Add-AzVirtualNetworkSubnetConfig is then used to add a subnet to the in-memory representation of the virtual network. The Set-AzVirtualNetwork command updates the existing virtual network with the new subnet.

$vnet = Get-AzVirtualNetwork -Name "myVNet" -ResourceGroupName "myResourceGroup"
$delegation = New-AzDelegation -Name "myDelegation" -ServiceName "Microsoft.Sql/servers"
Add-AzVirtualNetworkSubnetConfig -Name "mySubnet" -VirtualNetwork $vnet -AddressPrefix "10.0.2.0/24" -Delegation $delegation | Set-AzVirtualNetwork

This example first gets an existing vnet. Then, it creates a delegation object in memory. Finally, it creates a new subnet with that delegation that is added to the vnet. The modified configuration is then sent to the server.

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.