Get-AzPostgreSqlFlexibleServerVirtualEndpoint

Preview

Module:: Az.PostgreSqlFlexibleServer Module

This cmdlet is part of a Preview module. Preview versions aren't recommended for use in production environments. For more information, see https://aka.ms/azps-refstatus.

Gets information about a pair of virtual endpoints.

Syntax

List (Default)

Get-AzPostgreSqlFlexibleServerVirtualEndpoint
    -ResourceGroupName <String>
    -ServerName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityFlexibleServer

Get-AzPostgreSqlFlexibleServerVirtualEndpoint
    -Name <String>
    -FlexibleServerInputObject <IPostgreSqlFlexibleServerIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get

Get-AzPostgreSqlFlexibleServerVirtualEndpoint
    -Name <String>
    -ResourceGroupName <String>
    -ServerName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity

Get-AzPostgreSqlFlexibleServerVirtualEndpoint
    -InputObject <IPostgreSqlFlexibleServerIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Gets information about a pair of virtual endpoints.

Examples

Example 1: List all virtual endpoints in a flexible server

Get-AzPostgreSqlFlexibleServerVirtualEndpoint -SubscriptionId aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e -ResourceGroupName example-resource-group -ServerName example-server

Name                          EndpointType Member                                 PropertiesVirtualEndpoints
----                          ------------ ------                                 --------------------------
example-virtual-endpoint      ReadWrite    {example-server-01, example-server-02} {example-virtual-endpoint.writer.postgres.database.azure.com, example-virtual-endpoint.reader.postgres.database.azure.com}

Lists all virtual endpoints in an Azure Database for PostgreSQL flexible server with server name, resource group, and subscription explicitly passed as arguments. If subscription is not passed explicitly, it's taken from default context.

Example 2: Get one virtual endpoint in a flexible server

Get-AzPostgreSqlFlexibleServerVirtualEndpoint -SubscriptionId aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e -ResourceGroupName example-resource-group -ServerName example-server -Name example-virtual-endpoint

Name                          EndpointType Member                                 PropertiesVirtualEndpoints
----                          ------------ ------                                 --------------------------
example-virtual-endpoint      ReadWrite    {example-server-01, example-server-02} {example-virtual-endpoint.writer.postgres.database.azure.com, example-virtual-endpoint.reader.postgres.database.azure.com}

Gets one virtual endpoint in an Azure Database for PostgreSQL flexible server with virtual endpoints name, server name, resource group, and subscription explicitly passed as arguments. If subscription is not passed explicitly, it's taken from default context.

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

-FlexibleServerInputObject

Identity Parameter

Parameter properties

Type:	Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetViaIdentityFlexibleServer

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

Identity Parameter

Parameter properties

Type:	Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetViaIdentity

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

Base name of the virtual endpoints.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	VirtualEndpointName

Parameter sets

GetViaIdentityFlexibleServer

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

-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. The value must be an UUID.

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.

Inputs

Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IPostgreSqlFlexibleServerIdentity

Outputs

Microsoft.Azure.PowerShell.Cmdlets.PostgreSqlFlexibleServer.Models.IVirtualEndpoint

Feedback

Was this page helpful?