Neon.Postgres (stable:2025-03-01)

2025/03/24 • 39 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Neon.Postgres/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Organizations_ListBySubscription (new)
Description :  List OrganizationResource resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Neon.Postgres/organizations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The OrganizationResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
marketplaceDetails:
{
Description: Marketplace details of the resource. ,
Required: True ,
}
{
subscriptionId:
{
Description: SaaS subscription id for the the marketplace offer ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Purchased but not yet activated ,
Subscribed: Marketplace subscription is activated ,
Suspended: This state indicates that a customer's payment for the Marketplace service was not received ,
Unsubscribed: Customer has cancelled the subscription ,
}
,
Required: False ,
}
enum ,
offerDetails:
{
Description: Offer details for the marketplace that is selected by the user ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id for the marketplace offer ,
Required: True ,
}
string ,
offerId:
{
Description: Offer Id for the marketplace offer ,
Required: True ,
}
string ,
planId:
{
Description: Plan Id for the marketplace offer ,
Required: True ,
}
string ,
planName:
{
Description: Plan Name for the marketplace offer ,
Required: False ,
}
string ,
termUnit:
{
Description: Term Name for the marketplace offer ,
Required: False ,
}
string ,
termId:
{
Description: Term Id for the marketplace offer ,
Required: False ,
}
string ,
}
,
}
,
userDetails:
{
Description: Details of the user. ,
Required: True ,
}
{
firstName:
{
Description: First name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email address of the user ,
Required: False ,
}
string ,
upn:
{
Description: User's principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: User's phone number ,
Required: False ,
}
string ,
}
,
companyDetails:
{
Description: Details of the company. ,
Required: True ,
}
{
companyName:
{
Description: Company name ,
Required: False ,
}
string ,
country:
{
Description: Country name of the company ,
Required: False ,
}
string ,
officeAddress:
{
Description: Office address of the company ,
Required: False ,
}
string ,
businessPhone:
{
Description: Business phone number of the company ,
Required: False ,
}
string ,
domain:
{
Description: Domain of the user ,
Required: False ,
}
string ,
numberOfEmployees:
{
Description: Number of employees in the company ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
partnerOrganizationProperties:
{
Description: Neon Organization properties ,
Required: False ,
}
{
organizationId:
{
Description: Organization Id in partner's system ,
Required: False ,
}
string ,
organizationName:
{
Description: Organization name in partner's system ,
Required: True ,
}
string ,
singleSignOnProperties:
{
Description: Single Sign On properties for the organization ,
Required: False ,
}
{
singleSignOnState:
{
Description: State of the Single Sign On for the organization ,
Enum:
{
Initial: Initial state of the SSO resource ,
Enable: SSO is enabled for the organization ,
Disable: SSO is disabled for the organization ,
}
,
Required: False ,
}
enum ,
enterpriseAppId:
{
Description: AAD enterprise application Id used to setup SSO ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: URL for SSO to be used by the partner to redirect the user to their system ,
Required: False ,
}
string ,
aadDomains:
{
Description: List of AAD domains fetched from Microsoft Graph for user. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
projectProperties:
{
Description: Neon Project Properties ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
regionId:
{
Description: Region where the project is created ,
Required: False ,
}
string ,
storage:
{
Description: Data Storage bytes per hour for the project ,
Format: int64 ,
Required: False ,
}
integer ,
pgVersion:
{
Description: Postgres version for the project ,
Format: int32 ,
Required: False ,
}
integer ,
historyRetention:
{
Description: The retention period for project history in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultEndpointSettings:
{
Description: Default endpoint settings for the project. ,
Required: False ,
}
{
autoscalingLimitMinCu:
{
Description: Minimum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
autoscalingLimitMaxCu:
{
Description: Maximum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
}
,
branch:
{
Description: The Branch properties of the project. This is optional ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
roles:
{
Description: Roles associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Organizations_GetPostgresVersions (new)
Description :  Action to retrieve the PostgreSQL versions.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/getPostgresVersions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
parameters:
{
Description: Post Action to retrieve the PostgreSQL versions. ,
Required: False ,
}
{
version:
{
Description: The major PostgreSQL version number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
versions:
{
Description: List of PostgreSQL versions ,
Required: True ,
}
[
{
version:
{
Description: The major PostgreSQL version number ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Organizations_ListByResourceGroup (new)
Description :  List OrganizationResource resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The OrganizationResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
marketplaceDetails:
{
Description: Marketplace details of the resource. ,
Required: True ,
}
{
subscriptionId:
{
Description: SaaS subscription id for the the marketplace offer ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Purchased but not yet activated ,
Subscribed: Marketplace subscription is activated ,
Suspended: This state indicates that a customer's payment for the Marketplace service was not received ,
Unsubscribed: Customer has cancelled the subscription ,
}
,
Required: False ,
}
enum ,
offerDetails:
{
Description: Offer details for the marketplace that is selected by the user ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id for the marketplace offer ,
Required: True ,
}
string ,
offerId:
{
Description: Offer Id for the marketplace offer ,
Required: True ,
}
string ,
planId:
{
Description: Plan Id for the marketplace offer ,
Required: True ,
}
string ,
planName:
{
Description: Plan Name for the marketplace offer ,
Required: False ,
}
string ,
termUnit:
{
Description: Term Name for the marketplace offer ,
Required: False ,
}
string ,
termId:
{
Description: Term Id for the marketplace offer ,
Required: False ,
}
string ,
}
,
}
,
userDetails:
{
Description: Details of the user. ,
Required: True ,
}
{
firstName:
{
Description: First name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email address of the user ,
Required: False ,
}
string ,
upn:
{
Description: User's principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: User's phone number ,
Required: False ,
}
string ,
}
,
companyDetails:
{
Description: Details of the company. ,
Required: True ,
}
{
companyName:
{
Description: Company name ,
Required: False ,
}
string ,
country:
{
Description: Country name of the company ,
Required: False ,
}
string ,
officeAddress:
{
Description: Office address of the company ,
Required: False ,
}
string ,
businessPhone:
{
Description: Business phone number of the company ,
Required: False ,
}
string ,
domain:
{
Description: Domain of the user ,
Required: False ,
}
string ,
numberOfEmployees:
{
Description: Number of employees in the company ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
partnerOrganizationProperties:
{
Description: Neon Organization properties ,
Required: False ,
}
{
organizationId:
{
Description: Organization Id in partner's system ,
Required: False ,
}
string ,
organizationName:
{
Description: Organization name in partner's system ,
Required: True ,
}
string ,
singleSignOnProperties:
{
Description: Single Sign On properties for the organization ,
Required: False ,
}
{
singleSignOnState:
{
Description: State of the Single Sign On for the organization ,
Enum:
{
Initial: Initial state of the SSO resource ,
Enable: SSO is enabled for the organization ,
Disable: SSO is disabled for the organization ,
}
,
Required: False ,
}
enum ,
enterpriseAppId:
{
Description: AAD enterprise application Id used to setup SSO ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: URL for SSO to be used by the partner to redirect the user to their system ,
Required: False ,
}
string ,
aadDomains:
{
Description: List of AAD domains fetched from Microsoft Graph for user. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
projectProperties:
{
Description: Neon Project Properties ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
regionId:
{
Description: Region where the project is created ,
Required: False ,
}
string ,
storage:
{
Description: Data Storage bytes per hour for the project ,
Format: int64 ,
Required: False ,
}
integer ,
pgVersion:
{
Description: Postgres version for the project ,
Format: int32 ,
Required: False ,
}
integer ,
historyRetention:
{
Description: The retention period for project history in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultEndpointSettings:
{
Description: Default endpoint settings for the project. ,
Required: False ,
}
{
autoscalingLimitMinCu:
{
Description: Minimum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
autoscalingLimitMaxCu:
{
Description: Maximum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
}
,
branch:
{
Description: The Branch properties of the project. This is optional ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
roles:
{
Description: Roles associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Organizations_Get (new)
Description :  Get a OrganizationResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
marketplaceDetails:
{
Description: Marketplace details of the resource. ,
Required: True ,
}
{
subscriptionId:
{
Description: SaaS subscription id for the the marketplace offer ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Purchased but not yet activated ,
Subscribed: Marketplace subscription is activated ,
Suspended: This state indicates that a customer's payment for the Marketplace service was not received ,
Unsubscribed: Customer has cancelled the subscription ,
}
,
Required: False ,
}
enum ,
offerDetails:
{
Description: Offer details for the marketplace that is selected by the user ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id for the marketplace offer ,
Required: True ,
}
string ,
offerId:
{
Description: Offer Id for the marketplace offer ,
Required: True ,
}
string ,
planId:
{
Description: Plan Id for the marketplace offer ,
Required: True ,
}
string ,
planName:
{
Description: Plan Name for the marketplace offer ,
Required: False ,
}
string ,
termUnit:
{
Description: Term Name for the marketplace offer ,
Required: False ,
}
string ,
termId:
{
Description: Term Id for the marketplace offer ,
Required: False ,
}
string ,
}
,
}
,
userDetails:
{
Description: Details of the user. ,
Required: True ,
}
{
firstName:
{
Description: First name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email address of the user ,
Required: False ,
}
string ,
upn:
{
Description: User's principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: User's phone number ,
Required: False ,
}
string ,
}
,
companyDetails:
{
Description: Details of the company. ,
Required: True ,
}
{
companyName:
{
Description: Company name ,
Required: False ,
}
string ,
country:
{
Description: Country name of the company ,
Required: False ,
}
string ,
officeAddress:
{
Description: Office address of the company ,
Required: False ,
}
string ,
businessPhone:
{
Description: Business phone number of the company ,
Required: False ,
}
string ,
domain:
{
Description: Domain of the user ,
Required: False ,
}
string ,
numberOfEmployees:
{
Description: Number of employees in the company ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
partnerOrganizationProperties:
{
Description: Neon Organization properties ,
Required: False ,
}
{
organizationId:
{
Description: Organization Id in partner's system ,
Required: False ,
}
string ,
organizationName:
{
Description: Organization name in partner's system ,
Required: True ,
}
string ,
singleSignOnProperties:
{
Description: Single Sign On properties for the organization ,
Required: False ,
}
{
singleSignOnState:
{
Description: State of the Single Sign On for the organization ,
Enum:
{
Initial: Initial state of the SSO resource ,
Enable: SSO is enabled for the organization ,
Disable: SSO is disabled for the organization ,
}
,
Required: False ,
}
enum ,
enterpriseAppId:
{
Description: AAD enterprise application Id used to setup SSO ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: URL for SSO to be used by the partner to redirect the user to their system ,
Required: False ,
}
string ,
aadDomains:
{
Description: List of AAD domains fetched from Microsoft Graph for user. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
projectProperties:
{
Description: Neon Project Properties ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
regionId:
{
Description: Region where the project is created ,
Required: False ,
}
string ,
storage:
{
Description: Data Storage bytes per hour for the project ,
Format: int64 ,
Required: False ,
}
integer ,
pgVersion:
{
Description: Postgres version for the project ,
Format: int32 ,
Required: False ,
}
integer ,
historyRetention:
{
Description: The retention period for project history in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultEndpointSettings:
{
Description: Default endpoint settings for the project. ,
Required: False ,
}
{
autoscalingLimitMinCu:
{
Description: Minimum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
autoscalingLimitMaxCu:
{
Description: Maximum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
}
,
branch:
{
Description: The Branch properties of the project. This is optional ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
roles:
{
Description: Roles associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Organizations_CreateOrUpdate (new)
Description :  Create a OrganizationResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
marketplaceDetails:
{
Description: Marketplace details of the resource. ,
Required: True ,
}
{
subscriptionId:
{
Description: SaaS subscription id for the the marketplace offer ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Purchased but not yet activated ,
Subscribed: Marketplace subscription is activated ,
Suspended: This state indicates that a customer's payment for the Marketplace service was not received ,
Unsubscribed: Customer has cancelled the subscription ,
}
,
Required: False ,
}
enum ,
offerDetails:
{
Description: Offer details for the marketplace that is selected by the user ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id for the marketplace offer ,
Required: True ,
}
string ,
offerId:
{
Description: Offer Id for the marketplace offer ,
Required: True ,
}
string ,
planId:
{
Description: Plan Id for the marketplace offer ,
Required: True ,
}
string ,
planName:
{
Description: Plan Name for the marketplace offer ,
Required: False ,
}
string ,
termUnit:
{
Description: Term Name for the marketplace offer ,
Required: False ,
}
string ,
termId:
{
Description: Term Id for the marketplace offer ,
Required: False ,
}
string ,
}
,
}
,
userDetails:
{
Description: Details of the user. ,
Required: True ,
}
{
firstName:
{
Description: First name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email address of the user ,
Required: False ,
}
string ,
upn:
{
Description: User's principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: User's phone number ,
Required: False ,
}
string ,
}
,
companyDetails:
{
Description: Details of the company. ,
Required: True ,
}
{
companyName:
{
Description: Company name ,
Required: False ,
}
string ,
country:
{
Description: Country name of the company ,
Required: False ,
}
string ,
officeAddress:
{
Description: Office address of the company ,
Required: False ,
}
string ,
businessPhone:
{
Description: Business phone number of the company ,
Required: False ,
}
string ,
domain:
{
Description: Domain of the user ,
Required: False ,
}
string ,
numberOfEmployees:
{
Description: Number of employees in the company ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
partnerOrganizationProperties:
{
Description: Neon Organization properties ,
Required: False ,
}
{
organizationId:
{
Description: Organization Id in partner's system ,
Required: False ,
}
string ,
organizationName:
{
Description: Organization name in partner's system ,
Required: True ,
}
string ,
singleSignOnProperties:
{
Description: Single Sign On properties for the organization ,
Required: False ,
}
{
singleSignOnState:
{
Description: State of the Single Sign On for the organization ,
Enum:
{
Initial: Initial state of the SSO resource ,
Enable: SSO is enabled for the organization ,
Disable: SSO is disabled for the organization ,
}
,
Required: False ,
}
enum ,
enterpriseAppId:
{
Description: AAD enterprise application Id used to setup SSO ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: URL for SSO to be used by the partner to redirect the user to their system ,
Required: False ,
}
string ,
aadDomains:
{
Description: List of AAD domains fetched from Microsoft Graph for user. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
projectProperties:
{
Description: Neon Project Properties ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
regionId:
{
Description: Region where the project is created ,
Required: False ,
}
string ,
storage:
{
Description: Data Storage bytes per hour for the project ,
Format: int64 ,
Required: False ,
}
integer ,
pgVersion:
{
Description: Postgres version for the project ,
Format: int32 ,
Required: False ,
}
integer ,
historyRetention:
{
Description: The retention period for project history in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultEndpointSettings:
{
Description: Default endpoint settings for the project. ,
Required: False ,
}
{
autoscalingLimitMinCu:
{
Description: Minimum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
autoscalingLimitMaxCu:
{
Description: Maximum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
}
,
branch:
{
Description: The Branch properties of the project. This is optional ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
roles:
{
Description: Roles associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
marketplaceDetails:
{
Description: Marketplace details of the resource. ,
Required: True ,
}
{
subscriptionId:
{
Description: SaaS subscription id for the the marketplace offer ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Purchased but not yet activated ,
Subscribed: Marketplace subscription is activated ,
Suspended: This state indicates that a customer's payment for the Marketplace service was not received ,
Unsubscribed: Customer has cancelled the subscription ,
}
,
Required: False ,
}
enum ,
offerDetails:
{
Description: Offer details for the marketplace that is selected by the user ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id for the marketplace offer ,
Required: True ,
}
string ,
offerId:
{
Description: Offer Id for the marketplace offer ,
Required: True ,
}
string ,
planId:
{
Description: Plan Id for the marketplace offer ,
Required: True ,
}
string ,
planName:
{
Description: Plan Name for the marketplace offer ,
Required: False ,
}
string ,
termUnit:
{
Description: Term Name for the marketplace offer ,
Required: False ,
}
string ,
termId:
{
Description: Term Id for the marketplace offer ,
Required: False ,
}
string ,
}
,
}
,
userDetails:
{
Description: Details of the user. ,
Required: True ,
}
{
firstName:
{
Description: First name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email address of the user ,
Required: False ,
}
string ,
upn:
{
Description: User's principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: User's phone number ,
Required: False ,
}
string ,
}
,
companyDetails:
{
Description: Details of the company. ,
Required: True ,
}
{
companyName:
{
Description: Company name ,
Required: False ,
}
string ,
country:
{
Description: Country name of the company ,
Required: False ,
}
string ,
officeAddress:
{
Description: Office address of the company ,
Required: False ,
}
string ,
businessPhone:
{
Description: Business phone number of the company ,
Required: False ,
}
string ,
domain:
{
Description: Domain of the user ,
Required: False ,
}
string ,
numberOfEmployees:
{
Description: Number of employees in the company ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
partnerOrganizationProperties:
{
Description: Neon Organization properties ,
Required: False ,
}
{
organizationId:
{
Description: Organization Id in partner's system ,
Required: False ,
}
string ,
organizationName:
{
Description: Organization name in partner's system ,
Required: True ,
}
string ,
singleSignOnProperties:
{
Description: Single Sign On properties for the organization ,
Required: False ,
}
{
singleSignOnState:
{
Description: State of the Single Sign On for the organization ,
Enum:
{
Initial: Initial state of the SSO resource ,
Enable: SSO is enabled for the organization ,
Disable: SSO is disabled for the organization ,
}
,
Required: False ,
}
enum ,
enterpriseAppId:
{
Description: AAD enterprise application Id used to setup SSO ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: URL for SSO to be used by the partner to redirect the user to their system ,
Required: False ,
}
string ,
aadDomains:
{
Description: List of AAD domains fetched from Microsoft Graph for user. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
projectProperties:
{
Description: Neon Project Properties ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
regionId:
{
Description: Region where the project is created ,
Required: False ,
}
string ,
storage:
{
Description: Data Storage bytes per hour for the project ,
Format: int64 ,
Required: False ,
}
integer ,
pgVersion:
{
Description: Postgres version for the project ,
Format: int32 ,
Required: False ,
}
integer ,
historyRetention:
{
Description: The retention period for project history in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultEndpointSettings:
{
Description: Default endpoint settings for the project. ,
Required: False ,
}
{
autoscalingLimitMinCu:
{
Description: Minimum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
autoscalingLimitMaxCu:
{
Description: Maximum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
}
,
branch:
{
Description: The Branch properties of the project. This is optional ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
roles:
{
Description: Roles associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Organization Resource by Neon ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
marketplaceDetails:
{
Description: Marketplace details of the resource. ,
Required: True ,
}
{
subscriptionId:
{
Description: SaaS subscription id for the the marketplace offer ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Purchased but not yet activated ,
Subscribed: Marketplace subscription is activated ,
Suspended: This state indicates that a customer's payment for the Marketplace service was not received ,
Unsubscribed: Customer has cancelled the subscription ,
}
,
Required: False ,
}
enum ,
offerDetails:
{
Description: Offer details for the marketplace that is selected by the user ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id for the marketplace offer ,
Required: True ,
}
string ,
offerId:
{
Description: Offer Id for the marketplace offer ,
Required: True ,
}
string ,
planId:
{
Description: Plan Id for the marketplace offer ,
Required: True ,
}
string ,
planName:
{
Description: Plan Name for the marketplace offer ,
Required: False ,
}
string ,
termUnit:
{
Description: Term Name for the marketplace offer ,
Required: False ,
}
string ,
termId:
{
Description: Term Id for the marketplace offer ,
Required: False ,
}
string ,
}
,
}
,
userDetails:
{
Description: Details of the user. ,
Required: True ,
}
{
firstName:
{
Description: First name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email address of the user ,
Required: False ,
}
string ,
upn:
{
Description: User's principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: User's phone number ,
Required: False ,
}
string ,
}
,
companyDetails:
{
Description: Details of the company. ,
Required: True ,
}
{
companyName:
{
Description: Company name ,
Required: False ,
}
string ,
country:
{
Description: Country name of the company ,
Required: False ,
}
string ,
officeAddress:
{
Description: Office address of the company ,
Required: False ,
}
string ,
businessPhone:
{
Description: Business phone number of the company ,
Required: False ,
}
string ,
domain:
{
Description: Domain of the user ,
Required: False ,
}
string ,
numberOfEmployees:
{
Description: Number of employees in the company ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
partnerOrganizationProperties:
{
Description: Neon Organization properties ,
Required: False ,
}
{
organizationId:
{
Description: Organization Id in partner's system ,
Required: False ,
}
string ,
organizationName:
{
Description: Organization name in partner's system ,
Required: True ,
}
string ,
singleSignOnProperties:
{
Description: Single Sign On properties for the organization ,
Required: False ,
}
{
singleSignOnState:
{
Description: State of the Single Sign On for the organization ,
Enum:
{
Initial: Initial state of the SSO resource ,
Enable: SSO is enabled for the organization ,
Disable: SSO is disabled for the organization ,
}
,
Required: False ,
}
enum ,
enterpriseAppId:
{
Description: AAD enterprise application Id used to setup SSO ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: URL for SSO to be used by the partner to redirect the user to their system ,
Required: False ,
}
string ,
aadDomains:
{
Description: List of AAD domains fetched from Microsoft Graph for user. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
projectProperties:
{
Description: Neon Project Properties ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
regionId:
{
Description: Region where the project is created ,
Required: False ,
}
string ,
storage:
{
Description: Data Storage bytes per hour for the project ,
Format: int64 ,
Required: False ,
}
integer ,
pgVersion:
{
Description: Postgres version for the project ,
Format: int32 ,
Required: False ,
}
integer ,
historyRetention:
{
Description: The retention period for project history in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultEndpointSettings:
{
Description: Default endpoint settings for the project. ,
Required: False ,
}
{
autoscalingLimitMinCu:
{
Description: Minimum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
autoscalingLimitMaxCu:
{
Description: Maximum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
}
,
branch:
{
Description: The Branch properties of the project. This is optional ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
roles:
{
Description: Roles associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Organizations_Update (new)
Description :  Update a OrganizationResource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
userDetails:
{
Description: Details of the user. ,
Required: False ,
}
{
firstName:
{
Description: First name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email address of the user ,
Required: False ,
}
string ,
upn:
{
Description: User's principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: User's phone number ,
Required: False ,
}
string ,
}
,
companyDetails:
{
Description: Details of the company. ,
Required: False ,
}
{
companyName:
{
Description: Company name ,
Required: False ,
}
string ,
country:
{
Description: Country name of the company ,
Required: False ,
}
string ,
officeAddress:
{
Description: Office address of the company ,
Required: False ,
}
string ,
businessPhone:
{
Description: Business phone number of the company ,
Required: False ,
}
string ,
domain:
{
Description: Domain of the user ,
Required: False ,
}
string ,
numberOfEmployees:
{
Description: Number of employees in the company ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
partnerOrganizationProperties:
{
Description: Neon Organization properties ,
Required: False ,
}
{
organizationId:
{
Description: Organization Id in partner's system ,
Required: False ,
}
string ,
organizationName:
{
Description: Organization name in partner's system ,
Required: False ,
}
string ,
singleSignOnProperties:
{
Description: Single Sign On properties for the organization ,
Required: False ,
}
{
singleSignOnState:
{
Description: State of the Single Sign On for the organization ,
Enum:
{
Initial: Initial state of the SSO resource ,
Enable: SSO is enabled for the organization ,
Disable: SSO is disabled for the organization ,
}
,
Required: False ,
}
enum ,
enterpriseAppId:
{
Description: AAD enterprise application Id used to setup SSO ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: URL for SSO to be used by the partner to redirect the user to their system ,
Required: False ,
}
string ,
aadDomains:
{
Description: List of AAD domains fetched from Microsoft Graph for user. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
projectProperties:
{
Description: Neon Project Properties ,
Required: False ,
}
{
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
regionId:
{
Description: Region where the project is created ,
Required: False ,
}
string ,
storage:
{
Description: Data Storage bytes per hour for the project ,
Format: int64 ,
Required: False ,
}
integer ,
pgVersion:
{
Description: Postgres version for the project ,
Format: int32 ,
Required: False ,
}
integer ,
historyRetention:
{
Description: The retention period for project history in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultEndpointSettings:
{
Description: Default endpoint settings for the project. ,
Required: False ,
}
{
autoscalingLimitMinCu:
{
Description: Minimum compute units for autoscaling. ,
Format: float ,
Required: False ,
}
number ,
autoscalingLimitMaxCu:
{
Description: Maximum compute units for autoscaling. ,
Format: float ,
Required: False ,
}
number ,
}
,
branch:
{
Description: The Branch properties of the project. This is optional ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
roles:
{
Description: Roles associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
marketplaceDetails:
{
Description: Marketplace details of the resource. ,
Required: True ,
}
{
subscriptionId:
{
Description: SaaS subscription id for the the marketplace offer ,
Required: False ,
}
string ,
subscriptionStatus:
{
Description: Marketplace subscription status ,
Enum:
{
PendingFulfillmentStart: Purchased but not yet activated ,
Subscribed: Marketplace subscription is activated ,
Suspended: This state indicates that a customer's payment for the Marketplace service was not received ,
Unsubscribed: Customer has cancelled the subscription ,
}
,
Required: False ,
}
enum ,
offerDetails:
{
Description: Offer details for the marketplace that is selected by the user ,
Required: True ,
}
{
publisherId:
{
Description: Publisher Id for the marketplace offer ,
Required: True ,
}
string ,
offerId:
{
Description: Offer Id for the marketplace offer ,
Required: True ,
}
string ,
planId:
{
Description: Plan Id for the marketplace offer ,
Required: True ,
}
string ,
planName:
{
Description: Plan Name for the marketplace offer ,
Required: False ,
}
string ,
termUnit:
{
Description: Term Name for the marketplace offer ,
Required: False ,
}
string ,
termId:
{
Description: Term Id for the marketplace offer ,
Required: False ,
}
string ,
}
,
}
,
userDetails:
{
Description: Details of the user. ,
Required: True ,
}
{
firstName:
{
Description: First name of the user ,
Required: False ,
}
string ,
lastName:
{
Description: Last name of the user ,
Required: False ,
}
string ,
emailAddress:
{
Description: Email address of the user ,
Required: False ,
}
string ,
upn:
{
Description: User's principal name ,
Required: False ,
}
string ,
phoneNumber:
{
Description: User's phone number ,
Required: False ,
}
string ,
}
,
companyDetails:
{
Description: Details of the company. ,
Required: True ,
}
{
companyName:
{
Description: Company name ,
Required: False ,
}
string ,
country:
{
Description: Country name of the company ,
Required: False ,
}
string ,
officeAddress:
{
Description: Office address of the company ,
Required: False ,
}
string ,
businessPhone:
{
Description: Business phone number of the company ,
Required: False ,
}
string ,
domain:
{
Description: Domain of the user ,
Required: False ,
}
string ,
numberOfEmployees:
{
Description: Number of employees in the company ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
partnerOrganizationProperties:
{
Description: Neon Organization properties ,
Required: False ,
}
{
organizationId:
{
Description: Organization Id in partner's system ,
Required: False ,
}
string ,
organizationName:
{
Description: Organization name in partner's system ,
Required: True ,
}
string ,
singleSignOnProperties:
{
Description: Single Sign On properties for the organization ,
Required: False ,
}
{
singleSignOnState:
{
Description: State of the Single Sign On for the organization ,
Enum:
{
Initial: Initial state of the SSO resource ,
Enable: SSO is enabled for the organization ,
Disable: SSO is disabled for the organization ,
}
,
Required: False ,
}
enum ,
enterpriseAppId:
{
Description: AAD enterprise application Id used to setup SSO ,
Required: False ,
}
string ,
singleSignOnUrl:
{
Description: URL for SSO to be used by the partner to redirect the user to their system ,
Required: False ,
}
string ,
aadDomains:
{
Description: List of AAD domains fetched from Microsoft Graph for user. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
projectProperties:
{
Description: Neon Project Properties ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
regionId:
{
Description: Region where the project is created ,
Required: False ,
}
string ,
storage:
{
Description: Data Storage bytes per hour for the project ,
Format: int64 ,
Required: False ,
}
integer ,
pgVersion:
{
Description: Postgres version for the project ,
Format: int32 ,
Required: False ,
}
integer ,
historyRetention:
{
Description: The retention period for project history in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultEndpointSettings:
{
Description: Default endpoint settings for the project. ,
Required: False ,
}
{
autoscalingLimitMinCu:
{
Description: Minimum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
autoscalingLimitMaxCu:
{
Description: Maximum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
}
,
branch:
{
Description: The Branch properties of the project. This is optional ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
roles:
{
Description: Roles associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Organizations_Delete (new)
Description :  Delete a OrganizationResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Projects_List (new)
Description :  List Project resources by OrganizationResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Project items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
regionId:
{
Description: Region where the project is created ,
Required: False ,
}
string ,
storage:
{
Description: Data Storage bytes per hour for the project ,
Format: int64 ,
Required: False ,
}
integer ,
pgVersion:
{
Description: Postgres version for the project ,
Format: int32 ,
Required: False ,
}
integer ,
historyRetention:
{
Description: The retention period for project history in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultEndpointSettings:
{
Description: Default endpoint settings for the project. ,
Required: False ,
}
{
autoscalingLimitMinCu:
{
Description: Minimum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
autoscalingLimitMaxCu:
{
Description: Maximum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
}
,
branch:
{
Description: The Branch properties of the project. This is optional ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
roles:
{
Description: Roles associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Projects_Get (new)
Description :  Get a Project
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
regionId:
{
Description: Region where the project is created ,
Required: False ,
}
string ,
storage:
{
Description: Data Storage bytes per hour for the project ,
Format: int64 ,
Required: False ,
}
integer ,
pgVersion:
{
Description: Postgres version for the project ,
Format: int32 ,
Required: False ,
}
integer ,
historyRetention:
{
Description: The retention period for project history in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultEndpointSettings:
{
Description: Default endpoint settings for the project. ,
Required: False ,
}
{
autoscalingLimitMinCu:
{
Description: Minimum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
autoscalingLimitMaxCu:
{
Description: Maximum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
}
,
branch:
{
Description: The Branch properties of the project. This is optional ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
roles:
{
Description: Roles associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Projects_CreateOrUpdate (new)
Description :  Create a Project
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
regionId:
{
Description: Region where the project is created ,
Required: False ,
}
string ,
storage:
{
Description: Data Storage bytes per hour for the project ,
Format: int64 ,
Required: False ,
}
integer ,
pgVersion:
{
Description: Postgres version for the project ,
Format: int32 ,
Required: False ,
}
integer ,
historyRetention:
{
Description: The retention period for project history in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultEndpointSettings:
{
Description: Default endpoint settings for the project. ,
Required: False ,
}
{
autoscalingLimitMinCu:
{
Description: Minimum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
autoscalingLimitMaxCu:
{
Description: Maximum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
}
,
branch:
{
Description: The Branch properties of the project. This is optional ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
roles:
{
Description: Roles associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
regionId:
{
Description: Region where the project is created ,
Required: False ,
}
string ,
storage:
{
Description: Data Storage bytes per hour for the project ,
Format: int64 ,
Required: False ,
}
integer ,
pgVersion:
{
Description: Postgres version for the project ,
Format: int32 ,
Required: False ,
}
integer ,
historyRetention:
{
Description: The retention period for project history in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultEndpointSettings:
{
Description: Default endpoint settings for the project. ,
Required: False ,
}
{
autoscalingLimitMinCu:
{
Description: Minimum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
autoscalingLimitMaxCu:
{
Description: Maximum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
}
,
branch:
{
Description: The Branch properties of the project. This is optional ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
roles:
{
Description: Roles associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The Project resource type. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
regionId:
{
Description: Region where the project is created ,
Required: False ,
}
string ,
storage:
{
Description: Data Storage bytes per hour for the project ,
Format: int64 ,
Required: False ,
}
integer ,
pgVersion:
{
Description: Postgres version for the project ,
Format: int32 ,
Required: False ,
}
integer ,
historyRetention:
{
Description: The retention period for project history in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultEndpointSettings:
{
Description: Default endpoint settings for the project. ,
Required: False ,
}
{
autoscalingLimitMinCu:
{
Description: Minimum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
autoscalingLimitMaxCu:
{
Description: Maximum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
}
,
branch:
{
Description: The Branch properties of the project. This is optional ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
roles:
{
Description: Roles associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Projects_Update (new)
Description :  Update a Project
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
regionId:
{
Description: Region where the project is created ,
Required: False ,
}
string ,
storage:
{
Description: Data Storage bytes per hour for the project ,
Format: int64 ,
Required: False ,
}
integer ,
pgVersion:
{
Description: Postgres version for the project ,
Format: int32 ,
Required: False ,
}
integer ,
historyRetention:
{
Description: The retention period for project history in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultEndpointSettings:
{
Description: Default endpoint settings for the project. ,
Required: False ,
}
{
autoscalingLimitMinCu:
{
Description: Minimum compute units for autoscaling. ,
Format: float ,
Required: False ,
}
number ,
autoscalingLimitMaxCu:
{
Description: Maximum compute units for autoscaling. ,
Format: float ,
Required: False ,
}
number ,
}
,
branch:
{
Description: The Branch properties of the project. This is optional ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
roles:
{
Description: Roles associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
regionId:
{
Description: Region where the project is created ,
Required: False ,
}
string ,
storage:
{
Description: Data Storage bytes per hour for the project ,
Format: int64 ,
Required: False ,
}
integer ,
pgVersion:
{
Description: Postgres version for the project ,
Format: int32 ,
Required: False ,
}
integer ,
historyRetention:
{
Description: The retention period for project history in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
defaultEndpointSettings:
{
Description: Default endpoint settings for the project. ,
Required: False ,
}
{
autoscalingLimitMinCu:
{
Description: Minimum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
autoscalingLimitMaxCu:
{
Description: Maximum compute units for autoscaling. ,
Format: float ,
Required: True ,
}
number ,
}
,
branch:
{
Description: The Branch properties of the project. This is optional ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
roles:
{
Description: Roles associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the project ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Projects_Delete (new)
Description :  Delete a Project
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Branches_List (new)
Description :  List Branch resources by Project
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Branch items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Branches_Get (new)
Description :  Get a Branch
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Branches_CreateOrUpdate (new)
Description :  Create a Branch
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The Branch resource type. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Branches_Update (new)
Description :  Update a Branch
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this branch belongs to ,
Required: False ,
}
string ,
parentId:
{
Description: The ID of the parent branch ,
Required: False ,
}
string ,
roleName:
{
Description: Role name associated with the branch ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with the branch ,
Required: False ,
}
string ,
roles:
{
Description: Roles associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
]
,
databases:
{
Description: Neon Databases associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
]
,
endpoints:
{
Description: Endpoints associated with the branch ,
Required: False ,
}
[
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Branches_Delete (new)
Description :  Delete a Branch
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Computes_List (new)
Description :  List Compute resources by Branch
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}/computes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Compute items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
region:
{
Description: Region where the compute instance is located ,
Required: False ,
}
string ,
cpuCores:
{
Description: Number of allocated CPU cores ,
Format: int32 ,
Required: False ,
}
integer ,
memory:
{
Description: Memory allocated in GB ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Current status of the compute instance ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Computes_Get (new)
Description :  Get a Compute
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}/computes/{computeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
computeName:
{
Description: The name of the Compute ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
region:
{
Description: Region where the compute instance is located ,
Required: False ,
}
string ,
cpuCores:
{
Description: Number of allocated CPU cores ,
Format: int32 ,
Required: False ,
}
integer ,
memory:
{
Description: Memory allocated in GB ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Current status of the compute instance ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Computes_CreateOrUpdate (new)
Description :  Create a Compute
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}/computes/{computeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
computeName:
{
Description: The name of the Compute ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
region:
{
Description: Region where the compute instance is located ,
Required: False ,
}
string ,
cpuCores:
{
Description: Number of allocated CPU cores ,
Format: int32 ,
Required: False ,
}
integer ,
memory:
{
Description: Memory allocated in GB ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Current status of the compute instance ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
region:
{
Description: Region where the compute instance is located ,
Required: False ,
}
string ,
cpuCores:
{
Description: Number of allocated CPU cores ,
Format: int32 ,
Required: False ,
}
integer ,
memory:
{
Description: Memory allocated in GB ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Current status of the compute instance ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The Compute resource type. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
region:
{
Description: Region where the compute instance is located ,
Required: False ,
}
string ,
cpuCores:
{
Description: Number of allocated CPU cores ,
Format: int32 ,
Required: False ,
}
integer ,
memory:
{
Description: Memory allocated in GB ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Current status of the compute instance ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Computes_Update (new)
Description :  Update a Compute
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}/computes/{computeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
computeName:
{
Description: The name of the Compute ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
region:
{
Description: Region where the compute instance is located ,
Required: False ,
}
string ,
cpuCores:
{
Description: Number of allocated CPU cores ,
Format: int32 ,
Required: False ,
}
integer ,
memory:
{
Description: Memory allocated in GB ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Current status of the compute instance ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
region:
{
Description: Region where the compute instance is located ,
Required: False ,
}
string ,
cpuCores:
{
Description: Number of allocated CPU cores ,
Format: int32 ,
Required: False ,
}
integer ,
memory:
{
Description: Memory allocated in GB ,
Format: int32 ,
Required: False ,
}
integer ,
status:
{
Description: Current status of the compute instance ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Computes_Delete (new)
Description :  Delete a Compute
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}/computes/{computeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
computeName:
{
Description: The name of the Compute ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Endpoints_List (new)
Description :  List Endpoint resources by Branch
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}/endpoints
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Endpoint items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Endpoints_Get (new)
Description :  Get a Endpoint
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}/endpoints/{endpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of the Endpoint ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Endpoints_CreateOrUpdate (new)
Description :  Create a Endpoint
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}/endpoints/{endpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of the Endpoint ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The Neon compute endpoint resource type. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Endpoints_Update (new)
Description :  Update a Endpoint
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}/endpoints/{endpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of the Endpoint ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
projectId:
{
Description: The ID of the project this endpoint belongs to ,
Required: False ,
}
string ,
branchId:
{
Description: The ID of the branch this endpoint belongs to ,
Required: False ,
}
string ,
endpointType:
{
Description: The type of the endpoint ,
Enum:
{
read_only: ReadOnly compute endpoint type ,
read_write: ReadWrite compute endpoint type ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Endpoints_Delete (new)
Description :  Delete a Endpoint
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}/endpoints/{endpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
endpointName:
{
Description: The name of the Endpoint ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NeonDatabases_List (new)
Description :  List NeonDatabase resources by Branch
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}/neonDatabases
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NeonDatabase items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NeonDatabases_Get (new)
Description :  Get a NeonDatabase
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}/neonDatabases/{neonDatabaseName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
neonDatabaseName:
{
Description: The name of the NeonDatabase ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NeonDatabases_CreateOrUpdate (new)
Description :  Create a NeonDatabase
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}/neonDatabases/{neonDatabaseName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
neonDatabaseName:
{
Description: The name of the NeonDatabase ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The Neon Database resource type. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NeonDatabases_Update (new)
Description :  Update a NeonDatabase
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}/neonDatabases/{neonDatabaseName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
neonDatabaseName:
{
Description: The name of the NeonDatabase ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this database belongs to ,
Required: False ,
}
string ,
ownerName:
{
Description: The name of the role that owns the database ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NeonDatabases_Delete (new)
Description :  Delete a NeonDatabase
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}/neonDatabases/{neonDatabaseName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
neonDatabaseName:
{
Description: The name of the NeonDatabase ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NeonRoles_List (new)
Description :  List NeonRole resources by Branch
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}/neonRoles
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NeonRole items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NeonRoles_Get (new)
Description :  Get a NeonRole
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}/neonRoles/{neonRoleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
neonRoleName:
{
Description: The name of the NeonRole ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NeonRoles_CreateOrUpdate (new)
Description :  Create a NeonRole
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}/neonRoles/{neonRoleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
neonRoleName:
{
Description: The name of the NeonRole ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The Neon Role resource type. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NeonRoles_Update (new)
Description :  Update a NeonRole
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}/neonRoles/{neonRoleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
neonRoleName:
{
Description: The name of the NeonRole ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
entityId:
{
Description: Unique identifier for the entity ,
Required: False ,
}
string ,
entityName:
{
Description: Name of the resource ,
Required: False ,
}
string ,
createdAt:
{
Description: Timestamp indicating when the entity was created ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
}
,
Required: False ,
}
enum ,
attributes:
{
Description: Additional attributes for the entity ,
Required: False ,
}
[
{
name:
{
Description: Name of the attribute ,
Required: True ,
}
string ,
value:
{
Description: Value of the attribute ,
Required: True ,
}
string ,
}
,
]
,
branchId:
{
Description: The ID of the branch this role belongs to ,
Required: False ,
}
string ,
permissions:
{
Description: Permissions assigned to the role ,
Required: False ,
}
[
string ,
]
,
isSuperUser:
{
Description: Indicates whether the role has superuser privileges ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NeonRoles_Delete (new)
Description :  Delete a NeonRole
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}/neonRoles/{neonRoleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
branchName:
{
Description: The name of the Branch ,
Required: True ,
}
string ,
neonRoleName:
{
Description: The name of the NeonRole ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Projects_GetConnectionUri (new)
Description :  Action to retrieve the connection URI for the Neon Database.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/getConnectionUri
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
organizationName:
{
Description: Name of the Neon Organizations resource ,
Required: True ,
}
string ,
projectName:
{
Description: The name of the Project ,
Required: True ,
}
string ,
connectionUriParameters:
{
Description: Additional parameters for retrieving the database connection URI. ,
Required: True ,
}
{
projectId:
{
Description: Project Id associated with this connection ,
Required: False ,
}
string ,
branchId:
{
Description: Branch Id associated with this connection ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with this connection ,
Required: False ,
}
string ,
roleName:
{
Description: The role name used for authentication ,
Required: False ,
}
string ,
endpointId:
{
Description: the endpoint Id with this connection ,
Required: False ,
}
string ,
isPooled:
{
Description: Indicates if the connection is pooled ,
Required: False ,
}
boolean ,
connectionStringUri:
{
Description: connection uri returned for the database ,
Format: password ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
projectId:
{
Description: Project Id associated with this connection ,
Required: False ,
}
string ,
branchId:
{
Description: Branch Id associated with this connection ,
Required: False ,
}
string ,
databaseName:
{
Description: Database name associated with this connection ,
Required: False ,
}
string ,
roleName:
{
Description: The role name used for authentication ,
Required: False ,
}
string ,
endpointId:
{
Description: the endpoint Id with this connection ,
Required: False ,
}
string ,
isPooled:
{
Description: Indicates if the connection is pooled ,
Required: False ,
}
boolean ,
connectionStringUri:
{
Description: connection uri returned for the database ,
Format: password ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}