Set-AzVirtualNetworkSubnetConfig

Module:

Az.Network Module

Updates a subnet configuration for a virtual network.

Set-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>]

Set-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 Set-AzVirtualNetworkSubnetConfig cmdlet updates a subnet configuration for a 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

Set-AzVirtualNetworkSubnetConfig -Name frontendSubnet -VirtualNetwork $virtualNetwork -AddressPrefix "10.0.3.0/23"

$virtualNetwork | Set-AzVirtualNetwork

This example creates a virtual network with one subnet. Then is calls Set-AzVirtualNetworkSubnetConfig to modify the AddressPrefix of the subnet. This only impacts the in-memory representation of the virtual network. Set-AzVirtualNetwork is then called to modify the virtual network in Azure.

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

$rdpRule = New-AzNetworkSecurityRuleConfig -Name rdp-rule -Description "Allow RDP" -Access Allow -Protocol Tcp -Direction Inbound -Priority 100 -SourceAddressPrefix Internet -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389

$networkSecurityGroup = New-AzNetworkSecurityGroup -ResourceGroupName TestResourceGroup -Location centralus -Name "NSG-FrontEnd" -SecurityRules $rdpRule

Set-AzVirtualNetworkSubnetConfig -Name frontendSubnet -VirtualNetwork $virtualNetwork -AddressPrefix "10.0.1.0/24" -NetworkSecurityGroupId $networkSecurityGroup.Id

$virtualNetwork | Set-AzVirtualNetwork

This example creates a resource group with one virtual network containing just one subnet. It then creates a network security group with an allow rule for RDP traffic. The Set-AzVirtualNetworkSubnetConfig cmdlet is used to modify the in-memory representation of the frontend subnet so that it points to the newly created network security group. The Set-AzVirtualNetwork cmdlet is then called to write the modified state back to the service.

$pip = New-AzPublicIpAddress -Name "pip" -ResourceGroupName "natgateway_test" `
 -Location "eastus2" -Sku "Standard" -IdleTimeoutInMinutes 4 -AllocationMethod "static"

$natGateway = New-AzNatGateway -ResourceGroupName "natgateway_test" -Name "nat_gateway" `
 -IdleTimeoutInMinutes 4 -Sku "Standard" -Location "eastus2" -PublicIpAddress $pip

$frontendSubnet = New-AzVirtualNetworkSubnetConfig -Name frontendSubnet -AddressPrefix "10.0.1.0/24"

$virtualNetwork = New-AzVirtualNetwork -Name MyVirtualNetwork -ResourceGroupName TestResourceGroup -Location eastus2 -AddressPrefix "10.0.0.0/16" -Subnet $frontendSubnet

Set-AzVirtualNetworkSubnetConfig -Name frontendSubnet -VirtualNetwork $virtualNetwork -InputObject $natGateway -AddressPrefix "10.0.0.0/16"

$virtualNetwork | Set-AzVirtualNetwork

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.