Get-AzNeonPostgresProjectConnectionUri
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 .
Action to retrieve the connection URI for the Neon Database.
Syntax
GetExpanded (Default)
Get-AzNeonPostgresProjectConnectionUri
-OrganizationName <String>
-ProjectName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-BranchId <String>]
[-DatabaseName <String>]
[-EndpointId <String>]
[-IsPooled]
[-ProjectId <String>]
[-RoleName <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
GetViaJsonString
Get-AzNeonPostgresProjectConnectionUri
-OrganizationName <String>
-ProjectName <String>
-ResourceGroupName <String>
-JsonString <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
GetViaJsonFilePath
Get-AzNeonPostgresProjectConnectionUri
-OrganizationName <String>
-ProjectName <String>
-ResourceGroupName <String>
-JsonFilePath <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Get
Get-AzNeonPostgresProjectConnectionUri
-OrganizationName <String>
-ProjectName <String>
-ResourceGroupName <String>
-ConnectionUriParameter <IConnectionUriProperties>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
GetViaIdentityOrganizationExpanded
Get-AzNeonPostgresProjectConnectionUri
-ProjectName <String>
-OrganizationInputObject <INeonPostgresIdentity>
[-BranchId <String>]
[-DatabaseName <String>]
[-EndpointId <String>]
[-IsPooled]
[-ProjectId <String>]
[-RoleName <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
GetViaIdentityOrganization
Get-AzNeonPostgresProjectConnectionUri
-ProjectName <String>
-OrganizationInputObject <INeonPostgresIdentity>
-ConnectionUriParameter <IConnectionUriProperties>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
GetViaIdentityExpanded
Get-AzNeonPostgresProjectConnectionUri
-InputObject <INeonPostgresIdentity>
[-BranchId <String>]
[-DatabaseName <String>]
[-EndpointId <String>]
[-IsPooled]
[-ProjectId <String>]
[-RoleName <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
GetViaIdentity
Get-AzNeonPostgresProjectConnectionUri
-InputObject <INeonPostgresIdentity>
-ConnectionUriParameter <IConnectionUriProperties>
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Action to retrieve the connection URI for the Neon Database.
Examples
Example 1: Retrieve the connection URI for a specific Neon Postgres database
Get-AzNeonPostgresProjectConnectionUri -OrganizationName "NeonDemoOrgPS1" -ProjectName "dawn-breeze-86932057" -ResourceGroupName "neonrg" -SubscriptionId "00000000-0000-0000-0000-000000000000" -BranchId "br-damp-bird-a82olmcu" -DatabaseName "neondb" -EndpointId "ep-spring-cake-a88oisqp" -RoleName "neondb_owner"
BranchId : br-damp-bird-a82olmcu
ConnectionStringUri : System.Security.SecureString
DatabaseName : neondb
EndpointId : ep-spring-cake-a88oisqp
IsPooled : False
ProjectId : dawn-breeze-86932057
RoleName : neondb_owner
Retrieve the connection URI for a specific Neon Postgres database.
Parameters
-BranchId
Branch Id associated with this connection
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityOrganizationExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ConnectionUriParameter
Connection uri parameters for the associated database
Parameter properties
Parameter sets
Get
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityOrganization
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-DatabaseName
Database name associated with this connection
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityOrganizationExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-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
-EndpointId
the endpoint Id with this connection
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityOrganizationExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
GetViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-IsPooled
Indicates if the connection is pooled
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityOrganizationExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JsonFilePath
Path of Json file supplied to the Get operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JsonString
Json string supplied to the Get operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
GetViaIdentityOrganizationExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityOrganization
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-OrganizationName
Name of the Neon Organizations resource
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaJsonFilePath
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
-ProjectId
Project Id associated with this connection
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityOrganizationExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ProjectName
The name of the Project
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaJsonFilePath
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
GetViaIdentityOrganizationExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityOrganization
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
GetExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaJsonFilePath
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
-RoleName
The role name used for authentication
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
GetExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityOrganizationExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaIdentityExpanded
Position: Named Mandatory: False 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
GetExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaJsonString
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
GetViaJsonFilePath
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
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
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