Edit

Share via

Get-AzNeonPostgresBranch

  • Preview
Module:
Az.NeonPostgres 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.

Get a Branch

Syntax

List (Default) 

Get-AzNeonPostgresBranch
    -OrganizationName <String>
    -ProjectName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityProject 

Get-AzNeonPostgresBranch
    -Name <String>
    -ProjectInputObject <INeonPostgresIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentityOrganization 

Get-AzNeonPostgresBranch
    -Name <String>
    -ProjectName <String>
    -OrganizationInputObject <INeonPostgresIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Get 

Get-AzNeonPostgresBranch
    -Name <String>
    -OrganizationName <String>
    -ProjectName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity 

Get-AzNeonPostgresBranch
    -InputObject <INeonPostgresIdentity>
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Get a Branch

Examples

Example 1: List all branches resources within a specified project in Neon Postgres

Get-AzNeonPostgresBranch -ProjectName "dawn-breeze-86932056" -OrganizationName "NeonDemoOrgPS1" -ResourceGroupName "neonrg" -SubscriptionId "00000000-0000-0000-0000-000000000000"

Attribute                    : {{
                                 "name": "createdAt",
                                 "value": "May 12, 2025 8:02 AM"
                               }, {
                                 "name": "logicalSize",
                                 "value": "30785536"
                               }, {
                                 "name": "cpuUsedSec",
                                 "value": "0"
                               }, {
                                 "name": "computeTimeSeconds",
                                 "value": "0"
                               }…}
CreatedAt                    : May 12, 2025 8:02 AM
Database                     :
DatabaseName                 :
Endpoint                     :
EntityId                     : br-damp-bird-a82olmcu
EntityName                   : main
Id                           :
Name                         :
ParentId                     :
ProjectId                    : dawn-breeze-86932057
ProvisioningState            : idle
ResourceGroupName            :
Role                         :
RoleName                     :
SystemDataCreatedAt          :
SystemDataCreatedBy          :
SystemDataCreatedByType      :
SystemDataLastModifiedAt     :
SystemDataLastModifiedBy     :
SystemDataLastModifiedByType :
Type                         :

List all branches resources within a specified project in Neon Postgres

Example 2: Get Branch resource details within a specified project in Neon Postgres

Get-AzNeonPostgresBranch -Name "br-damp-bird-a82olmcu" -ProjectName "dawn-breeze-86932056" -OrganizationName "NeonDemoOrgPS1" -ResourceGroupName "neonrg" -SubscriptionId "00000000-0000-0000-0000-000000000000"

Attribute                    : {{
                                 "name": "logicalSize",
                                 "value": "30785536"
                               }, {
                                 "name": "cpuUsedSec",
                                 "value": "0"
                               }, {
                                 "name": "computeTimeSeconds",
                                 "value": "0"
                               }, {
                                 "name": "activeTimeSeconds",
                                 "value": "0"
                               }…}
CreatedAt                    : May 12, 2025 8:02 AM
Database                     :
DatabaseName                 :
Endpoint                     :
EntityId                     : br-damp-bird-a82olmcu
EntityName                   : main
Id                           :
Name                         :
ParentId                     :
ProjectId                    : dawn-breeze-86932057
ProvisioningState            : Succeeded
ResourceGroupName            :
Role                         :
RoleName                     :
SystemDataCreatedAt          :
SystemDataCreatedBy          :
SystemDataCreatedByType      :
SystemDataLastModifiedAt     :
SystemDataLastModifiedBy     :
SystemDataLastModifiedByType :
Type                         :

Get Branch resource details within a specified project in Neon Postgres

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

-InputObject

Identity Parameter

Parameter properties

Type:INeonPostgresIdentity
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

The name of the Branch

Parameter properties

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

Parameter sets

GetViaIdentityProject
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
Get
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OrganizationInputObject

Identity Parameter

Parameter properties

Type:INeonPostgresIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

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

-ProjectInputObject

Identity Parameter

Parameter properties

Type:INeonPostgresIdentity
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

GetViaIdentityProject
Position:Named
Mandatory:True
Value from pipeline:True
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

List
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
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

-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

INeonPostgresIdentity

Outputs

IBranch