New-AzNeonPostgresBranch
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 .
Syntax
CreateExpanded (Default)
New-AzNeonPostgresBranch
-Name <String>
-OrganizationName <String>
-ProjectName <String>
-ResourceGroupName <String>
[-SubscriptionId <String>]
[-Attribute <IAttributes[]>]
[-Database <INeonDatabaseProperties[]>]
[-DatabaseName <String>]
[-Endpoint <IEndpointProperties[]>]
[-EntityName <String>]
[-ParentId <String>]
[-ProjectId <String>]
[-Role <INeonRoleProperties[]>]
[-RoleName <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaJsonFilePath
New-AzNeonPostgresBranch
-Name <String>
-OrganizationName <String>
-ProjectName <String>
-ResourceGroupName <String>
-JsonFilePath <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaJsonString
New-AzNeonPostgresBranch
-Name <String>
-OrganizationName <String>
-ProjectName <String>
-ResourceGroupName <String>
-JsonString <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Examples
Example 1: Create a new branch within a Neon Postgres database
New-AzNeonPostgresBranch -Name "test-branch" -OrganizationName "NeonDemoOrgPS1" -ProjectName "dawn-breeze-86932057" -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 :
Create a new branch within a Neon Postgres database.
Parameters
-AsJob
Run the command as a job
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
-Attribute
Additional attributes for the entity
Parameter properties
Type: IAttributes [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
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
-Database
Neon Databases associated with the branch
Parameter properties
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DatabaseName
Database name associated with the branch
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
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
-Endpoint
Endpoints associated with the branch
Parameter properties
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EntityName
Name of the resource
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
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 Create operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateViaJsonFilePath
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 Create operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateViaJsonString
Position: Named Mandatory: True Value from pipeline: False 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
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NoWait
Run the command asynchronously
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
-OrganizationName
Name of the Neon Organizations resource
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ParentId
The ID of the parent branch
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ProjectId
The ID of the project this branch belongs to
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
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
(All)
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
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Role
Roles associated with the branch
Parameter properties
Parameter sets
CreateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-RoleName
Role name associated with the branch
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
CreateExpanded
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
(All)
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