Anteckning
Åtkomst till den här sidan kräver auktorisering. Du kan prova att logga in eller ändra kataloger.
Åtkomst till den här sidan kräver auktorisering. Du kan prova att ändra kataloger.
Bicep-resursdefinition
Resurstypen organisationer/projekt/grenar kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Neon.Postgres/organizations/projects/branch-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Neon.Postgres/organizations/projects/branches@2025-03-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
attributes: [
{
name: 'string'
value: 'string'
}
]
databaseName: 'string'
databases: [
{
attributes: [
{
name: 'string'
value: 'string'
}
]
branchId: 'string'
entityName: 'string'
ownerName: 'string'
}
]
endpoints: [
{
attributes: [
{
name: 'string'
value: 'string'
}
]
branchId: 'string'
endpointType: 'string'
entityName: 'string'
projectId: 'string'
}
]
entityName: 'string'
parentId: 'string'
projectId: 'string'
roleName: 'string'
roles: [
{
attributes: [
{
name: 'string'
value: 'string'
}
]
branchId: 'string'
entityName: 'string'
isSuperUser: bool
permissions: [
'string'
]
}
]
}
}
Egenskapsvärden
Egenskaper
| Namn | Beskrivning | Värde |
|---|---|---|
| namn | Namnet på attributet | sträng (krävs) |
| värde | Värdet för attributet | sträng (krävs) |
BranchProperties (på engelska)
| Namn | Beskrivning | Värde |
|---|---|---|
| Egenskaper | Ytterligare attribut för entiteten | Attribut[] |
| databasNamn | Databasnamn som är associerat med grenen | sträng |
| Databaser | Neondatabaser som är associerade med grenen | NeonDatabaseProperties[] |
| Slutpunkter | Slutpunkter som är associerade med grenen | EndpointProperties[] |
| entityName (enhet) | Resursens namn | sträng Begränsningar: Mönster = ^\S.{0,62}\S$|^\S$ |
| parentId | ID för den överordnade grenen | sträng Begränsningar: Mönster = ^[a-z0-9-]{1,60}$ |
| project-id | ID:t för projektet som den här grenen tillhör | sträng |
| rollnamn | Rollnamn som är associerat med grenen | sträng |
| Roller | Roller som är associerade med grenen | NeonRoleProperties[] |
EndpointProperties (Slutpunkt) Egenskaper
| Namn | Beskrivning | Värde |
|---|---|---|
| Egenskaper | Ytterligare attribut för entiteten | Attribut[] |
| branchId | ID:t för den gren som den här slutpunkten tillhör | sträng |
| slutpunktTyp | Typ av slutpunkt | "read_only" "read_write" |
| entityName (enhet) | Resursens namn | sträng Begränsningar: Mönster = ^\S.{0,62}\S$|^\S$ |
| project-id | ID:t för projektet som den här slutpunkten tillhör | sträng |
Neon.Postgres/organisationer/projekt/filialer
| Namn | Beskrivning | Värde |
|---|---|---|
| namn | Resursnamnet | sträng Begränsningar: Mönster = ^\S.{0,62}\S$|^\S$ (krävs) |
| förälder | I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför den överordnade resursen. |
Symboliskt namn för resurs av typen: organisationer/projekt |
| egenskaper | Resursspecifika egenskaper för den här resursen. | BranchProperties (på engelska) |
NeonDatabaseProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| Egenskaper | Ytterligare attribut för entiteten | Attribut[] |
| branchId | ID:t för den gren som den här databasen tillhör | sträng |
| entityName (enhet) | Resursens namn | sträng Begränsningar: Mönster = ^\S.{0,62}\S$|^\S$ |
| ownerName | Namnet på den roll som äger databasen | sträng |
NeonRoleProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| Egenskaper | Ytterligare attribut för entiteten | Attribut[] |
| branchId | ID:t för grenen som den här rollen tillhör | sträng |
| entityName (enhet) | Resursens namn | sträng Begränsningar: Mönster = ^\S.{0,62}\S$|^\S$ |
| isSuperUser | Anger om rollen har superanvändarbehörighet | Bool |
| Behörigheter | Behörigheter som tilldelats rollen | sträng[] |
Resursdefinition för ARM-mall
Resurstypen organisationer/projekt/grenar kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Neon.Postgres/organizations/projects/branch-resurs lägger du till följande JSON i mallen.
{
"type": "Neon.Postgres/organizations/projects/branches",
"apiVersion": "2025-03-01",
"name": "string",
"properties": {
"attributes": [
{
"name": "string",
"value": "string"
}
],
"databaseName": "string",
"databases": [
{
"attributes": [
{
"name": "string",
"value": "string"
}
],
"branchId": "string",
"entityName": "string",
"ownerName": "string"
}
],
"endpoints": [
{
"attributes": [
{
"name": "string",
"value": "string"
}
],
"branchId": "string",
"endpointType": "string",
"entityName": "string",
"projectId": "string"
}
],
"entityName": "string",
"parentId": "string",
"projectId": "string",
"roleName": "string",
"roles": [
{
"attributes": [
{
"name": "string",
"value": "string"
}
],
"branchId": "string",
"entityName": "string",
"isSuperUser": "bool",
"permissions": [ "string" ]
}
]
}
}
Egenskapsvärden
Egenskaper
| Namn | Beskrivning | Värde |
|---|---|---|
| namn | Namnet på attributet | sträng (krävs) |
| värde | Värdet för attributet | sträng (krävs) |
BranchProperties (på engelska)
| Namn | Beskrivning | Värde |
|---|---|---|
| Egenskaper | Ytterligare attribut för entiteten | Attribut[] |
| databasNamn | Databasnamn som är associerat med grenen | sträng |
| Databaser | Neondatabaser som är associerade med grenen | NeonDatabaseProperties[] |
| Slutpunkter | Slutpunkter som är associerade med grenen | EndpointProperties[] |
| entityName (enhet) | Resursens namn | sträng Begränsningar: Mönster = ^\S.{0,62}\S$|^\S$ |
| parentId | ID för den överordnade grenen | sträng Begränsningar: Mönster = ^[a-z0-9-]{1,60}$ |
| project-id | ID:t för projektet som den här grenen tillhör | sträng |
| rollnamn | Rollnamn som är associerat med grenen | sträng |
| Roller | Roller som är associerade med grenen | NeonRoleProperties[] |
EndpointProperties (Slutpunkt) Egenskaper
| Namn | Beskrivning | Värde |
|---|---|---|
| Egenskaper | Ytterligare attribut för entiteten | Attribut[] |
| branchId | ID:t för den gren som den här slutpunkten tillhör | sträng |
| slutpunktTyp | Typ av slutpunkt | "read_only" "read_write" |
| entityName (enhet) | Resursens namn | sträng Begränsningar: Mönster = ^\S.{0,62}\S$|^\S$ |
| project-id | ID:t för projektet som den här slutpunkten tillhör | sträng |
Neon.Postgres/organisationer/projekt/filialer
| Namn | Beskrivning | Värde |
|---|---|---|
| apiVersion | API-versionen | '2025-03-01' |
| namn | Resursnamnet | sträng Begränsningar: Mönster = ^\S.{0,62}\S$|^\S$ (krävs) |
| egenskaper | Resursspecifika egenskaper för den här resursen. | BranchProperties (på engelska) |
| typ | Resurstypen | "Neon.Postgres/organizations/projects/branchs" |
NeonDatabaseProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| Egenskaper | Ytterligare attribut för entiteten | Attribut[] |
| branchId | ID:t för den gren som den här databasen tillhör | sträng |
| entityName (enhet) | Resursens namn | sträng Begränsningar: Mönster = ^\S.{0,62}\S$|^\S$ |
| ownerName | Namnet på den roll som äger databasen | sträng |
NeonRoleProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| Egenskaper | Ytterligare attribut för entiteten | Attribut[] |
| branchId | ID:t för grenen som den här rollen tillhör | sträng |
| entityName (enhet) | Resursens namn | sträng Begränsningar: Mönster = ^\S.{0,62}\S$|^\S$ |
| isSuperUser | Anger om rollen har superanvändarbehörighet | Bool |
| Behörigheter | Behörigheter som tilldelats rollen | sträng[] |
Användningsexempel
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen organisationer/projekt/grenar kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Neon.Postgres/organizations/projects/branch-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Neon.Postgres/organizations/projects/branches@2025-03-01"
name = "string"
parent_id = "string"
body = {
properties = {
attributes = [
{
name = "string"
value = "string"
}
]
databaseName = "string"
databases = [
{
attributes = [
{
name = "string"
value = "string"
}
]
branchId = "string"
entityName = "string"
ownerName = "string"
}
]
endpoints = [
{
attributes = [
{
name = "string"
value = "string"
}
]
branchId = "string"
endpointType = "string"
entityName = "string"
projectId = "string"
}
]
entityName = "string"
parentId = "string"
projectId = "string"
roleName = "string"
roles = [
{
attributes = [
{
name = "string"
value = "string"
}
]
branchId = "string"
entityName = "string"
isSuperUser = bool
permissions = [
"string"
]
}
]
}
}
}
Egenskapsvärden
Egenskaper
| Namn | Beskrivning | Värde |
|---|---|---|
| namn | Namnet på attributet | sträng (krävs) |
| värde | Värdet för attributet | sträng (krävs) |
BranchProperties (på engelska)
| Namn | Beskrivning | Värde |
|---|---|---|
| Egenskaper | Ytterligare attribut för entiteten | Attribut[] |
| databasNamn | Databasnamn som är associerat med grenen | sträng |
| Databaser | Neondatabaser som är associerade med grenen | NeonDatabaseProperties[] |
| Slutpunkter | Slutpunkter som är associerade med grenen | EndpointProperties[] |
| entityName (enhet) | Resursens namn | sträng Begränsningar: Mönster = ^\S.{0,62}\S$|^\S$ |
| parentId | ID för den överordnade grenen | sträng Begränsningar: Mönster = ^[a-z0-9-]{1,60}$ |
| project-id | ID:t för projektet som den här grenen tillhör | sträng |
| rollnamn | Rollnamn som är associerat med grenen | sträng |
| Roller | Roller som är associerade med grenen | NeonRoleProperties[] |
EndpointProperties (Slutpunkt) Egenskaper
| Namn | Beskrivning | Värde |
|---|---|---|
| Egenskaper | Ytterligare attribut för entiteten | Attribut[] |
| branchId | ID:t för den gren som den här slutpunkten tillhör | sträng |
| slutpunktTyp | Typ av slutpunkt | "read_only" "read_write" |
| entityName (enhet) | Resursens namn | sträng Begränsningar: Mönster = ^\S.{0,62}\S$|^\S$ |
| project-id | ID:t för projektet som den här slutpunkten tillhör | sträng |
Neon.Postgres/organisationer/projekt/filialer
| Namn | Beskrivning | Värde |
|---|---|---|
| namn | Resursnamnet | sträng Begränsningar: Mönster = ^\S.{0,62}\S$|^\S$ (krävs) |
| parent_id | ID för resursen som är överordnad för den här resursen. | ID för resurs av typen: organisationer/projekt |
| egenskaper | Resursspecifika egenskaper för den här resursen. | BranchProperties (på engelska) |
| typ | Resurstypen | "Neon.Postgres/organisationer/projekt/branches@2025-03-01" |
NeonDatabaseProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| Egenskaper | Ytterligare attribut för entiteten | Attribut[] |
| branchId | ID:t för den gren som den här databasen tillhör | sträng |
| entityName (enhet) | Resursens namn | sträng Begränsningar: Mönster = ^\S.{0,62}\S$|^\S$ |
| ownerName | Namnet på den roll som äger databasen | sträng |
NeonRoleProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| Egenskaper | Ytterligare attribut för entiteten | Attribut[] |
| branchId | ID:t för grenen som den här rollen tillhör | sträng |
| entityName (enhet) | Resursens namn | sträng Begränsningar: Mönster = ^\S.{0,62}\S$|^\S$ |
| isSuperUser | Anger om rollen har superanvändarbehörighet | Bool |
| Behörigheter | Behörigheter som tilldelats rollen | sträng[] |