AzMySQLVirtualNetworkRule

Overview

The AzMySQLVirtualNetworkRule cmdlet creates, updates, or removes a virtual network rule for a MySQL server in Azure. Virtual network rules enable Azure resources within a virtual network to connect securely to a MySQL server.

Syntax

New-AzMySQLVirtualNetworkRule
   -Name <String>
   -ResourceGroupName <String>
   -ServerName <String>
   -SubnetId <String>
   [-IgnoreMissingEndpoint] [CommonParameters]

Set-AzMySQLVirtualNetworkRule
   -Name <String>
   -ResourceGroupName <String>
   -ServerName <String>
   [-SubnetId <String>] [-IgnoreMissingEndpoint] [CommonParameters]

Remove-AzMySQLVirtualNetworkRule
   -Name <String>
   -ResourceGroupName <String>
   -ServerName <String>
   [CommonParameters]

Get-AzMySQLVirtualNetworkRule
   [-ResourceGroupName <String>] [-ServerName <String>] [CommonParameters]

Parameters

Parameter	Type	Description
-Name	String	Unique name of the virtual network rule.
-ResourceGroupName	String	Name of the resource group containing the MySQL server.
-ServerName	String	Name of the MySQL server.
-SubnetId	String	Resource ID of the subnet to which the rule applies.
-IgnoreMissingEndpoint	Switch	If set, creation succeeds even if the subnet is not yet linked to the virtual network.
-WhatIf, -Confirm	CommonParameters	PowerShell's standard confirmation switches.

Examples

1. Create a virtual network rule

New-AzMySQLVirtualNetworkRule `
  -Name "vnetRule1" `
  -ResourceGroupName "MyResourceGroup" `
  -ServerName "myMysqlServer" `
  -SubnetId "/subscriptions/xxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet"

2. Update an existing rule to point to a different subnet

Set-AzMySQLVirtualNetworkRule `
  -Name "vnetRule1" `
  -ResourceGroupName "MyResourceGroup" `
  -ServerName "myMysqlServer" `
  -SubnetId "/subscriptions/xxxxxx/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/otherSubnet"

3. List all virtual network rules for a server

Get-AzMySQLVirtualNetworkRule -ResourceGroupName "MyResourceGroup" -ServerName "myMysqlServer"

4. Remove a virtual network rule

Remove-AzMySQLVirtualNetworkRule -Name "vnetRule1" -ResourceGroupName "MyResourceGroup" -ServerName "myMysqlServer"