Get-AzPostgreSqlVirtualNetworkRule
Gets a virtual network rule.
Syntax
Get-AzPostgreSqlVirtualNetworkRule
-ResourceGroupName <String>
-ServerName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[-PassThru]
[<CommonParameters>] Get-AzPostgreSqlVirtualNetworkRule
-Name <String>
-ResourceGroupName <String>
-ServerName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[-PassThru]
[<CommonParameters>] Get-AzPostgreSqlVirtualNetworkRule
-InputObject <IPostgreSqlIdentity>
[-DefaultProfile <PSObject>]
[-PassThru]
[<CommonParameters>] Description
Gets a virtual network rule.
Examples
Example 1: Lists all the Virtual Network Rules in specified PostgreSql server
Get-AzPostgreSqlVirtualNetworkRule -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer
Name Type
---- ----
vnet Microsoft.DBforPostgreSQL/servers/virtualNetworkRulesThis cmdlet lists all the Virtual Network Rules in specified PostgreSql server.
Example 2: Get Virtual Network Rule by name
Get-AzPostgreSqlVirtualNetworkRule -Name vnet -ResourceGroupName PostgreSqlTestRG -ServerName PostgreSqlTestServer
Name Type
---- ----
vnet Microsoft.DBforPostgreSQL/servers/virtualNetworkRulesThis cmdlet gets Virtual Network Rule by name.
Example 3: Get Virtual Network Rule by identity
$ID = "/subscriptions/<SubscriptionId>/resourceGroups/PostgreSqlTestRG/providers/Microsoft.DBforPostgreSQL/servers/PostgreSqlTestServer/virtualNetworkRules/vnet"
Get-AzPostgreSqlVirtualNetworkRule -InputObject $ID
Name Type
---- ----
vnet Microsoft.DBforPostgreSQL/servers/virtualNetworkRulesThis cmdlet gets Virtual Network Rule by identity.
Parameters
-DefaultProfile
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
| Type: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
| Type: | IPostgreSqlIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
The name of the virtual network rule.
| Type: | String |
| Aliases: | VirtualNetworkRuleName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PassThru
Returns true when the command succeeds
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServerName
The name of the server.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
The ID of the target subscription.
| Type: | String[] |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |