Share via


Neon.Postgres organizations

Bicep resource definition

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

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

Resource format

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

resource symbolicname 'Neon.Postgres/organizations@2025-03-01' = {
  location: 'string'
  name: 'string'
  properties: {
    companyDetails: {
      businessPhone: 'string'
      companyName: 'string'
      country: 'string'
      domain: 'string'
      numberOfEmployees: int
      officeAddress: 'string'
    }
    marketplaceDetails: {
      offerDetails: {
        offerId: 'string'
        planId: 'string'
        planName: 'string'
        publisherId: 'string'
        termId: 'string'
        termUnit: 'string'
      }
      subscriptionId: 'string'
      subscriptionStatus: 'string'
    }
    partnerOrganizationProperties: {
      organizationId: 'string'
      organizationName: 'string'
      singleSignOnProperties: {
        aadDomains: [
          'string'
        ]
        enterpriseAppId: 'string'
        singleSignOnState: 'string'
        singleSignOnUrl: 'string'
      }
    }
    projectProperties: {
      attributes: [
        {
          name: 'string'
          value: 'string'
        }
      ]
      branch: {
        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'
            ]
          }
        ]
      }
      databases: [
        {
          attributes: [
            {
              name: 'string'
              value: 'string'
            }
          ]
          branchId: 'string'
          entityName: 'string'
          ownerName: 'string'
        }
      ]
      defaultEndpointSettings: {
        autoscalingLimitMaxCu: int
        autoscalingLimitMinCu: int
      }
      endpoints: [
        {
          attributes: [
            {
              name: 'string'
              value: 'string'
            }
          ]
          branchId: 'string'
          endpointType: 'string'
          entityName: 'string'
          projectId: 'string'
        }
      ]
      entityName: 'string'
      historyRetention: int
      pgVersion: int
      regionId: 'string'
      roles: [
        {
          attributes: [
            {
              name: 'string'
              value: 'string'
            }
          ]
          branchId: 'string'
          entityName: 'string'
          isSuperUser: bool
          permissions: [
            'string'
          ]
        }
      ]
      storage: int
    }
    userDetails: {
      emailAddress: 'string'
      firstName: 'string'
      lastName: 'string'
      phoneNumber: 'string'
      upn: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Neon.Postgres/organizations

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 1
Max length = 50
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$ (required)
properties The resource-specific properties for this resource. LiftrBaseDataOrganizationProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

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[]

DefaultEndpointSettings

Name Description Value
autoscalingLimitMaxCu Maximum compute units for autoscaling. int (required)
autoscalingLimitMinCu Minimum compute units for autoscaling. int (required)

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

LiftrBaseCompanyDetails

Name Description Value
businessPhone Business phone number of the company string
companyName Company name string
country Country name of the company string
domain Domain of the user string
numberOfEmployees Number of employees in the company int
officeAddress Office address of the company string

LiftrBaseDataOrganizationProperties

Name Description Value
companyDetails Details of the company. LiftrBaseCompanyDetails (required)
marketplaceDetails Marketplace details of the resource. LiftrBaseMarketplaceDetails (required)
partnerOrganizationProperties Neon Organization properties LiftrBaseDataPartnerOrganizationProperties
projectProperties Neon Project Properties ProjectProperties
userDetails Details of the user. LiftrBaseUserDetails (required)

LiftrBaseDataPartnerOrganizationProperties

Name Description Value
organizationId Organization Id in partner's system string
organizationName Organization name in partner's system string

Constraints:
Min length = 1
Max length = 50
Pattern = ^\S.{0,62}\S$|^\S$ (required)
singleSignOnProperties Single Sign On properties for the organization LiftrBaseSingleSignOnProperties

LiftrBaseMarketplaceDetails

Name Description Value
offerDetails Offer details for the marketplace that is selected by the user LiftrBaseOfferDetails (required)
subscriptionId SaaS subscription id for the the marketplace offer string
subscriptionStatus Marketplace subscription status 'PendingFulfillmentStart'
'Subscribed'
'Suspended'
'Unsubscribed'

LiftrBaseOfferDetails

Name Description Value
offerId Offer Id for the marketplace offer string (required)
planId Plan Id for the marketplace offer string (required)
planName Plan Name for the marketplace offer string
publisherId Publisher Id for the marketplace offer string (required)
termId Term Id for the marketplace offer string
termUnit Term Name for the marketplace offer string

LiftrBaseSingleSignOnProperties

Name Description Value
aadDomains List of AAD domains fetched from Microsoft Graph for user. string[]
enterpriseAppId AAD enterprise application Id used to setup SSO string
singleSignOnState State of the Single Sign On for the organization 'Disable'
'Enable'
'Initial'
singleSignOnUrl URL for SSO to be used by the partner to redirect the user to their system string

LiftrBaseUserDetails

Name Description Value
emailAddress Email address of the user string

Constraints:
Pattern = ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$
firstName First name of the user string
lastName Last name of the user string
phoneNumber User's phone number string
upn User's principal name 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[]

ProjectProperties

Name Description Value
attributes Additional attributes for the entity Attributes[]
branch The Branch properties of the project. This is optional BranchProperties
databases Neon Databases associated with the project NeonDatabaseProperties[]
defaultEndpointSettings Default endpoint settings for the project. DefaultEndpointSettings
endpoints Endpoints associated with the project EndpointProperties[]
entityName Name of the resource string

Constraints:
Pattern = ^\S.{0,62}\S$|^\S$
historyRetention The retention period for project history in seconds. int
pgVersion Postgres version for the project int
regionId Region where the project is created string
roles Roles associated with the project NeonRoleProperties[]
storage Data Storage bytes per hour for the project int

TrackedResourceTags

Name Description Value

ARM template resource definition

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

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

Resource format

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

{
  "type": "Neon.Postgres/organizations",
  "apiVersion": "2025-03-01",
  "name": "string",
  "location": "string",
  "properties": {
    "companyDetails": {
      "businessPhone": "string",
      "companyName": "string",
      "country": "string",
      "domain": "string",
      "numberOfEmployees": "int",
      "officeAddress": "string"
    },
    "marketplaceDetails": {
      "offerDetails": {
        "offerId": "string",
        "planId": "string",
        "planName": "string",
        "publisherId": "string",
        "termId": "string",
        "termUnit": "string"
      },
      "subscriptionId": "string",
      "subscriptionStatus": "string"
    },
    "partnerOrganizationProperties": {
      "organizationId": "string",
      "organizationName": "string",
      "singleSignOnProperties": {
        "aadDomains": [ "string" ],
        "enterpriseAppId": "string",
        "singleSignOnState": "string",
        "singleSignOnUrl": "string"
      }
    },
    "projectProperties": {
      "attributes": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "branch": {
        "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" ]
          }
        ]
      },
      "databases": [
        {
          "attributes": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "branchId": "string",
          "entityName": "string",
          "ownerName": "string"
        }
      ],
      "defaultEndpointSettings": {
        "autoscalingLimitMaxCu": "int",
        "autoscalingLimitMinCu": "int"
      },
      "endpoints": [
        {
          "attributes": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "branchId": "string",
          "endpointType": "string",
          "entityName": "string",
          "projectId": "string"
        }
      ],
      "entityName": "string",
      "historyRetention": "int",
      "pgVersion": "int",
      "regionId": "string",
      "roles": [
        {
          "attributes": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "branchId": "string",
          "entityName": "string",
          "isSuperUser": "bool",
          "permissions": [ "string" ]
        }
      ],
      "storage": "int"
    },
    "userDetails": {
      "emailAddress": "string",
      "firstName": "string",
      "lastName": "string",
      "phoneNumber": "string",
      "upn": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Neon.Postgres/organizations

Name Description Value
apiVersion The api version '2025-03-01'
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 1
Max length = 50
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$ (required)
properties The resource-specific properties for this resource. LiftrBaseDataOrganizationProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Neon.Postgres/organizations'

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[]

DefaultEndpointSettings

Name Description Value
autoscalingLimitMaxCu Maximum compute units for autoscaling. int (required)
autoscalingLimitMinCu Minimum compute units for autoscaling. int (required)

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

LiftrBaseCompanyDetails

Name Description Value
businessPhone Business phone number of the company string
companyName Company name string
country Country name of the company string
domain Domain of the user string
numberOfEmployees Number of employees in the company int
officeAddress Office address of the company string

LiftrBaseDataOrganizationProperties

Name Description Value
companyDetails Details of the company. LiftrBaseCompanyDetails (required)
marketplaceDetails Marketplace details of the resource. LiftrBaseMarketplaceDetails (required)
partnerOrganizationProperties Neon Organization properties LiftrBaseDataPartnerOrganizationProperties
projectProperties Neon Project Properties ProjectProperties
userDetails Details of the user. LiftrBaseUserDetails (required)

LiftrBaseDataPartnerOrganizationProperties

Name Description Value
organizationId Organization Id in partner's system string
organizationName Organization name in partner's system string

Constraints:
Min length = 1
Max length = 50
Pattern = ^\S.{0,62}\S$|^\S$ (required)
singleSignOnProperties Single Sign On properties for the organization LiftrBaseSingleSignOnProperties

LiftrBaseMarketplaceDetails

Name Description Value
offerDetails Offer details for the marketplace that is selected by the user LiftrBaseOfferDetails (required)
subscriptionId SaaS subscription id for the the marketplace offer string
subscriptionStatus Marketplace subscription status 'PendingFulfillmentStart'
'Subscribed'
'Suspended'
'Unsubscribed'

LiftrBaseOfferDetails

Name Description Value
offerId Offer Id for the marketplace offer string (required)
planId Plan Id for the marketplace offer string (required)
planName Plan Name for the marketplace offer string
publisherId Publisher Id for the marketplace offer string (required)
termId Term Id for the marketplace offer string
termUnit Term Name for the marketplace offer string

LiftrBaseSingleSignOnProperties

Name Description Value
aadDomains List of AAD domains fetched from Microsoft Graph for user. string[]
enterpriseAppId AAD enterprise application Id used to setup SSO string
singleSignOnState State of the Single Sign On for the organization 'Disable'
'Enable'
'Initial'
singleSignOnUrl URL for SSO to be used by the partner to redirect the user to their system string

LiftrBaseUserDetails

Name Description Value
emailAddress Email address of the user string

Constraints:
Pattern = ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$
firstName First name of the user string
lastName Last name of the user string
phoneNumber User's phone number string
upn User's principal name 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[]

ProjectProperties

Name Description Value
attributes Additional attributes for the entity Attributes[]
branch The Branch properties of the project. This is optional BranchProperties
databases Neon Databases associated with the project NeonDatabaseProperties[]
defaultEndpointSettings Default endpoint settings for the project. DefaultEndpointSettings
endpoints Endpoints associated with the project EndpointProperties[]
entityName Name of the resource string

Constraints:
Pattern = ^\S.{0,62}\S$|^\S$
historyRetention The retention period for project history in seconds. int
pgVersion Postgres version for the project int
regionId Region where the project is created string
roles Roles associated with the project NeonRoleProperties[]
storage Data Storage bytes per hour for the project int

TrackedResourceTags

Name Description Value

Usage Examples

Terraform (AzAPI provider) resource definition

The organizations 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 resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Neon.Postgres/organizations@2025-03-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      companyDetails = {
        businessPhone = "string"
        companyName = "string"
        country = "string"
        domain = "string"
        numberOfEmployees = int
        officeAddress = "string"
      }
      marketplaceDetails = {
        offerDetails = {
          offerId = "string"
          planId = "string"
          planName = "string"
          publisherId = "string"
          termId = "string"
          termUnit = "string"
        }
        subscriptionId = "string"
        subscriptionStatus = "string"
      }
      partnerOrganizationProperties = {
        organizationId = "string"
        organizationName = "string"
        singleSignOnProperties = {
          aadDomains = [
            "string"
          ]
          enterpriseAppId = "string"
          singleSignOnState = "string"
          singleSignOnUrl = "string"
        }
      }
      projectProperties = {
        attributes = [
          {
            name = "string"
            value = "string"
          }
        ]
        branch = {
          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"
              ]
            }
          ]
        }
        databases = [
          {
            attributes = [
              {
                name = "string"
                value = "string"
              }
            ]
            branchId = "string"
            entityName = "string"
            ownerName = "string"
          }
        ]
        defaultEndpointSettings = {
          autoscalingLimitMaxCu = int
          autoscalingLimitMinCu = int
        }
        endpoints = [
          {
            attributes = [
              {
                name = "string"
                value = "string"
              }
            ]
            branchId = "string"
            endpointType = "string"
            entityName = "string"
            projectId = "string"
          }
        ]
        entityName = "string"
        historyRetention = int
        pgVersion = int
        regionId = "string"
        roles = [
          {
            attributes = [
              {
                name = "string"
                value = "string"
              }
            ]
            branchId = "string"
            entityName = "string"
            isSuperUser = bool
            permissions = [
              "string"
            ]
          }
        ]
        storage = int
      }
      userDetails = {
        emailAddress = "string"
        firstName = "string"
        lastName = "string"
        phoneNumber = "string"
        upn = "string"
      }
    }
  }
}

Property Values

Neon.Postgres/organizations

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 1
Max length = 50
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$ (required)
properties The resource-specific properties for this resource. LiftrBaseDataOrganizationProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Neon.Postgres/organizations@2025-03-01"

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[]

DefaultEndpointSettings

Name Description Value
autoscalingLimitMaxCu Maximum compute units for autoscaling. int (required)
autoscalingLimitMinCu Minimum compute units for autoscaling. int (required)

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

LiftrBaseCompanyDetails

Name Description Value
businessPhone Business phone number of the company string
companyName Company name string
country Country name of the company string
domain Domain of the user string
numberOfEmployees Number of employees in the company int
officeAddress Office address of the company string

LiftrBaseDataOrganizationProperties

Name Description Value
companyDetails Details of the company. LiftrBaseCompanyDetails (required)
marketplaceDetails Marketplace details of the resource. LiftrBaseMarketplaceDetails (required)
partnerOrganizationProperties Neon Organization properties LiftrBaseDataPartnerOrganizationProperties
projectProperties Neon Project Properties ProjectProperties
userDetails Details of the user. LiftrBaseUserDetails (required)

LiftrBaseDataPartnerOrganizationProperties

Name Description Value
organizationId Organization Id in partner's system string
organizationName Organization name in partner's system string

Constraints:
Min length = 1
Max length = 50
Pattern = ^\S.{0,62}\S$|^\S$ (required)
singleSignOnProperties Single Sign On properties for the organization LiftrBaseSingleSignOnProperties

LiftrBaseMarketplaceDetails

Name Description Value
offerDetails Offer details for the marketplace that is selected by the user LiftrBaseOfferDetails (required)
subscriptionId SaaS subscription id for the the marketplace offer string
subscriptionStatus Marketplace subscription status 'PendingFulfillmentStart'
'Subscribed'
'Suspended'
'Unsubscribed'

LiftrBaseOfferDetails

Name Description Value
offerId Offer Id for the marketplace offer string (required)
planId Plan Id for the marketplace offer string (required)
planName Plan Name for the marketplace offer string
publisherId Publisher Id for the marketplace offer string (required)
termId Term Id for the marketplace offer string
termUnit Term Name for the marketplace offer string

LiftrBaseSingleSignOnProperties

Name Description Value
aadDomains List of AAD domains fetched from Microsoft Graph for user. string[]
enterpriseAppId AAD enterprise application Id used to setup SSO string
singleSignOnState State of the Single Sign On for the organization 'Disable'
'Enable'
'Initial'
singleSignOnUrl URL for SSO to be used by the partner to redirect the user to their system string

LiftrBaseUserDetails

Name Description Value
emailAddress Email address of the user string

Constraints:
Pattern = ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$
firstName First name of the user string
lastName Last name of the user string
phoneNumber User's phone number string
upn User's principal name 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[]

ProjectProperties

Name Description Value
attributes Additional attributes for the entity Attributes[]
branch The Branch properties of the project. This is optional BranchProperties
databases Neon Databases associated with the project NeonDatabaseProperties[]
defaultEndpointSettings Default endpoint settings for the project. DefaultEndpointSettings
endpoints Endpoints associated with the project EndpointProperties[]
entityName Name of the resource string

Constraints:
Pattern = ^\S.{0,62}\S$|^\S$
historyRetention The retention period for project history in seconds. int
pgVersion Postgres version for the project int
regionId Region where the project is created string
roles Roles associated with the project NeonRoleProperties[]
storage Data Storage bytes per hour for the project int

TrackedResourceTags

Name Description Value