Get-AzPostgreSqlVirtualNetworkRule
Gets a virtual network rule.
Syntax
List (Default)
Get-AzPostgreSqlVirtualNetworkRule
-ResourceGroupName <String>
-ServerName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[-PassThru]
[<CommonParameters>]
Get
Get-AzPostgreSqlVirtualNetworkRule
-Name <String>
-ResourceGroupName <String>
-ServerName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[-PassThru]
[<CommonParameters>]
GetViaIdentity
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/virtualNetworkRules
This 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/virtualNetworkRules
This 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/virtualNetworkRules
This 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.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
GetViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of the virtual network rule.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: VirtualNetworkRuleName
Parameter sets
Get
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PassThru
Returns true when the command succeeds
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
The name is case insensitive.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
List
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ServerName
The name of the server.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
List
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
The ID of the target subscription.
Parameter properties
Type: String [ ]
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
List
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Get
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
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 .
Outputs
