Neon.Postgres organizations/projects/branches 2025-03-01-preview

2025-05-13

Bicep resource definition

The organizations/projects/branches resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Neon.Postgres/organizations/projects/branches resource, add the following Bicep to your template.

resource symbolicname 'Neon.Postgres/organizations/projects/branches@2025-03-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    attributes: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    databaseName: 'string'
    databases: [
      {
        attributes: [
          {
            name: 'string'
            value: 'string'
          }
        ]
        branchId: 'string'
        entityName: 'string'
        ownerName: 'string'
      }
    ]
    endpoints: [
      {
        attributes: [
          {
            name: 'string'
            value: 'string'
          }
        ]
        branchId: 'string'
        endpointType: 'string'
        entityName: 'string'
        projectId: 'string'
      }
    ]
    entityName: 'string'
    parentId: 'string'
    projectId: 'string'
    roleName: 'string'
    roles: [
      {
        attributes: [
          {
            name: 'string'
            value: 'string'
          }
        ]
        branchId: 'string'
        entityName: 'string'
        isSuperUser: bool
        permissions: [
          'string'
        ]
      }
    ]
  }
}

Property Values

Neon.Postgres/organizations/projects/branches

Name	Description	Value
name	The resource name	string Constraints: Pattern = `^\S.{0,62}\S$\|^\S$` (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: organizations/projects
properties	The resource-specific properties for this resource.	BranchProperties

Attributes

Name	Description	Value
name	Name of the attribute	string (required)
value	Value of the attribute	string (required)

BranchProperties

Name	Description	Value
attributes	Additional attributes for the entity	Attributes[]
databaseName	Database name associated with the branch	string
databases	Neon Databases associated with the branch	NeonDatabaseProperties[]
endpoints	Endpoints associated with the branch	EndpointProperties[]
entityName	Name of the resource	string Constraints: Pattern = `^\S.{0,62}\S$\|^\S$`
parentId	The ID of the parent branch	string Constraints: Pattern = `^[a-z0-9-]{1,60}$`
projectId	The ID of the project this branch belongs to	string
roleName	Role name associated with the branch	string
roles	Roles associated with the branch	NeonRoleProperties[]

EndpointProperties

Name	Description	Value
attributes	Additional attributes for the entity	Attributes[]
branchId	The ID of the branch this endpoint belongs to	string
endpointType	The type of the endpoint	'read_only' 'read_write'
entityName	Name of the resource	string Constraints: Pattern = `^\S.{0,62}\S$\|^\S$`
projectId	The ID of the project this endpoint belongs to	string

NeonDatabaseProperties

Name	Description	Value
attributes	Additional attributes for the entity	Attributes[]
branchId	The ID of the branch this database belongs to	string
entityName	Name of the resource	string Constraints: Pattern = `^\S.{0,62}\S$\|^\S$`
ownerName	The name of the role that owns the database	string

NeonRoleProperties

Name	Description	Value
attributes	Additional attributes for the entity	Attributes[]
branchId	The ID of the branch this role belongs to	string
entityName	Name of the resource	string Constraints: Pattern = `^\S.{0,62}\S$\|^\S$`
isSuperUser	Indicates whether the role has superuser privileges	bool
permissions	Permissions assigned to the role	string[]

ARM template resource definition

The organizations/projects/branches resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Neon.Postgres/organizations/projects/branches resource, add the following JSON to your template.

{
  "type": "Neon.Postgres/organizations/projects/branches",
  "apiVersion": "2025-03-01-preview",
  "name": "string",
  "properties": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "databaseName": "string",
    "databases": [
      {
        "attributes": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "branchId": "string",
        "entityName": "string",
        "ownerName": "string"
      }
    ],
    "endpoints": [
      {
        "attributes": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "branchId": "string",
        "endpointType": "string",
        "entityName": "string",
        "projectId": "string"
      }
    ],
    "entityName": "string",
    "parentId": "string",
    "projectId": "string",
    "roleName": "string",
    "roles": [
      {
        "attributes": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "branchId": "string",
        "entityName": "string",
        "isSuperUser": "bool",
        "permissions": [ "string" ]
      }
    ]
  }
}

Property Values

Neon.Postgres/organizations/projects/branches

Name	Description	Value
apiVersion	The api version	'2025-03-01-preview'
name	The resource name	string Constraints: Pattern = `^\S.{0,62}\S$\|^\S$` (required)
properties	The resource-specific properties for this resource.	BranchProperties
type	The resource type	'Neon.Postgres/organizations/projects/branches'

Attributes

Name	Description	Value
name	Name of the attribute	string (required)
value	Value of the attribute	string (required)

BranchProperties

Name	Description	Value
attributes	Additional attributes for the entity	Attributes[]
databaseName	Database name associated with the branch	string
databases	Neon Databases associated with the branch	NeonDatabaseProperties[]
endpoints	Endpoints associated with the branch	EndpointProperties[]
entityName	Name of the resource	string Constraints: Pattern = `^\S.{0,62}\S$\|^\S$`
parentId	The ID of the parent branch	string Constraints: Pattern = `^[a-z0-9-]{1,60}$`
projectId	The ID of the project this branch belongs to	string
roleName	Role name associated with the branch	string
roles	Roles associated with the branch	NeonRoleProperties[]

EndpointProperties

Name	Description	Value
attributes	Additional attributes for the entity	Attributes[]
branchId	The ID of the branch this endpoint belongs to	string
endpointType	The type of the endpoint	'read_only' 'read_write'
entityName	Name of the resource	string Constraints: Pattern = `^\S.{0,62}\S$\|^\S$`
projectId	The ID of the project this endpoint belongs to	string

NeonDatabaseProperties

Name	Description	Value
attributes	Additional attributes for the entity	Attributes[]
branchId	The ID of the branch this database belongs to	string
entityName	Name of the resource	string Constraints: Pattern = `^\S.{0,62}\S$\|^\S$`
ownerName	The name of the role that owns the database	string

NeonRoleProperties

Name	Description	Value
attributes	Additional attributes for the entity	Attributes[]
branchId	The ID of the branch this role belongs to	string
entityName	Name of the resource	string Constraints: Pattern = `^\S.{0,62}\S$\|^\S$`
isSuperUser	Indicates whether the role has superuser privileges	bool
permissions	Permissions assigned to the role	string[]

Usage Examples

Terraform (AzAPI provider) resource definition

The organizations/projects/branches resource type can be deployed with operations that target:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Neon.Postgres/organizations/projects/branches resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Neon.Postgres/organizations/projects/branches@2025-03-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      attributes = [
        {
          name = "string"
          value = "string"
        }
      ]
      databaseName = "string"
      databases = [
        {
          attributes = [
            {
              name = "string"
              value = "string"
            }
          ]
          branchId = "string"
          entityName = "string"
          ownerName = "string"
        }
      ]
      endpoints = [
        {
          attributes = [
            {
              name = "string"
              value = "string"
            }
          ]
          branchId = "string"
          endpointType = "string"
          entityName = "string"
          projectId = "string"
        }
      ]
      entityName = "string"
      parentId = "string"
      projectId = "string"
      roleName = "string"
      roles = [
        {
          attributes = [
            {
              name = "string"
              value = "string"
            }
          ]
          branchId = "string"
          entityName = "string"
          isSuperUser = bool
          permissions = [
            "string"
          ]
        }
      ]
    }
  }
}

Property Values

Neon.Postgres/organizations/projects/branches

Name	Description	Value
name	The resource name	string Constraints: Pattern = `^\S.{0,62}\S$\|^\S$` (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: organizations/projects
properties	The resource-specific properties for this resource.	BranchProperties
type	The resource type	"Neon.Postgres/organizations/projects/branches@2025-03-01-preview"

Attributes

Name	Description	Value
name	Name of the attribute	string (required)
value	Value of the attribute	string (required)

BranchProperties

Name	Description	Value
attributes	Additional attributes for the entity	Attributes[]
databaseName	Database name associated with the branch	string
databases	Neon Databases associated with the branch	NeonDatabaseProperties[]
endpoints	Endpoints associated with the branch	EndpointProperties[]
entityName	Name of the resource	string Constraints: Pattern = `^\S.{0,62}\S$\|^\S$`
parentId	The ID of the parent branch	string Constraints: Pattern = `^[a-z0-9-]{1,60}$`
projectId	The ID of the project this branch belongs to	string
roleName	Role name associated with the branch	string
roles	Roles associated with the branch	NeonRoleProperties[]

EndpointProperties

Name	Description	Value
attributes	Additional attributes for the entity	Attributes[]
branchId	The ID of the branch this endpoint belongs to	string
endpointType	The type of the endpoint	'read_only' 'read_write'
entityName	Name of the resource	string Constraints: Pattern = `^\S.{0,62}\S$\|^\S$`
projectId	The ID of the project this endpoint belongs to	string

NeonDatabaseProperties

Name	Description	Value
attributes	Additional attributes for the entity	Attributes[]
branchId	The ID of the branch this database belongs to	string
entityName	Name of the resource	string Constraints: Pattern = `^\S.{0,62}\S$\|^\S$`
ownerName	The name of the role that owns the database	string

NeonRoleProperties

Name	Description	Value
attributes	Additional attributes for the entity	Attributes[]
branchId	The ID of the branch this role belongs to	string
entityName	Name of the resource	string Constraints: Pattern = `^\S.{0,62}\S$\|^\S$`
isSuperUser	Indicates whether the role has superuser privileges	bool
permissions	Permissions assigned to the role	string[]

Share via

Neon.Postgres organizations/projects/branches 2025-03-01-preview

Bicep resource definition

Resource format

Property Values

Neon.Postgres/organizations/projects/branches

Attributes

BranchProperties

EndpointProperties

NeonDatabaseProperties

NeonRoleProperties

ARM template resource definition

Resource format

Property Values

Neon.Postgres/organizations/projects/branches

Attributes

BranchProperties

EndpointProperties

NeonDatabaseProperties

NeonRoleProperties

Usage Examples

Terraform (AzAPI provider) resource definition

Resource format

Property Values

Neon.Postgres/organizations/projects/branches

Attributes

BranchProperties

EndpointProperties

NeonDatabaseProperties

NeonRoleProperties

Feedback

Additional resources