Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The organizations resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Neon.Postgres/organizations resource, add the following Bicep to your template.
resource symbolicname 'Neon.Postgres/organizations@2024-12-22-preview' = {
location: 'string'
name: 'string'
properties: {
companyDetails: {
businessPhone: 'string'
companyName: 'string'
country: 'string'
domain: 'string'
numberOfEmployees: int
officeAddress: 'string'
}
marketplaceDetails: {
offerDetails: {
offerId: 'string'
planId: 'string'
planName: 'string'
publisherId: 'string'
termId: 'string'
termUnit: 'string'
}
subscriptionId: 'string'
subscriptionStatus: 'string'
}
partnerOrganizationProperties: {
organizationId: 'string'
organizationName: 'string'
singleSignOnProperties: {
aadDomains: [
'string'
]
enterpriseAppId: 'string'
singleSignOnState: 'string'
singleSignOnUrl: 'string'
}
}
userDetails: {
emailAddress: 'string'
firstName: 'string'
lastName: 'string'
phoneNumber: 'string'
upn: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Property Values
Neon.Postgres/organizations
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 50 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$ (required) |
| properties | The resource-specific properties for this resource. | LiftrBaseDataOrganizationProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
LiftrBaseCompanyDetails
| Name | Description | Value |
|---|---|---|
| businessPhone | Business phone number of the company | string |
| companyName | Company name | string |
| country | Country name of the company | string |
| domain | Domain of the user | string |
| numberOfEmployees | Number of employees in the company | int |
| officeAddress | Office address of the company | string |
LiftrBaseDataOrganizationProperties
| Name | Description | Value |
|---|---|---|
| companyDetails | Details of the company. | LiftrBaseCompanyDetails (required) |
| marketplaceDetails | Marketplace details of the resource. | LiftrBaseMarketplaceDetails (required) |
| partnerOrganizationProperties | Neon Organization properties | LiftrBaseDataPartnerOrganizationProperties |
| userDetails | Details of the user. | LiftrBaseUserDetails (required) |
LiftrBaseDataPartnerOrganizationProperties
| Name | Description | Value |
|---|---|---|
| organizationId | Organization Id in partner's system | string |
| organizationName | Organization name in partner's system | string Constraints: Min length = 1 Max length = 50 Pattern = ^\S.{0,62}\S$|^\S$ (required) |
| singleSignOnProperties | Single Sign On properties for the organization | LiftrBaseSingleSignOnProperties |
LiftrBaseMarketplaceDetails
| Name | Description | Value |
|---|---|---|
| offerDetails | Offer details for the marketplace that is selected by the user | LiftrBaseOfferDetails (required) |
| subscriptionId | SaaS subscription id for the the marketplace offer | string |
| subscriptionStatus | Marketplace subscription status | 'PendingFulfillmentStart' 'Subscribed' 'Suspended' 'Unsubscribed' |
LiftrBaseOfferDetails
| Name | Description | Value |
|---|---|---|
| offerId | Offer Id for the marketplace offer | string (required) |
| planId | Plan Id for the marketplace offer | string (required) |
| planName | Plan Name for the marketplace offer | string |
| publisherId | Publisher Id for the marketplace offer | string (required) |
| termId | Term Id for the marketplace offer | string |
| termUnit | Term Name for the marketplace offer | string |
LiftrBaseSingleSignOnProperties
| Name | Description | Value |
|---|---|---|
| aadDomains | List of AAD domains fetched from Microsoft Graph for user. | string[] |
| enterpriseAppId | AAD enterprise application Id used to setup SSO | string |
| singleSignOnState | State of the Single Sign On for the organization | 'Disable' 'Enable' 'Initial' |
| singleSignOnUrl | URL for SSO to be used by the partner to redirect the user to their system | string |
LiftrBaseUserDetails
| Name | Description | Value |
|---|---|---|
| emailAddress | Email address of the user | string Constraints: Pattern = ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$ |
| firstName | First name of the user | string |
| lastName | Last name of the user | string |
| phoneNumber | User's phone number | string |
| upn | User's principal name | string |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The organizations resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Neon.Postgres/organizations resource, add the following JSON to your template.
{
"type": "Neon.Postgres/organizations",
"apiVersion": "2024-12-22-preview",
"name": "string",
"location": "string",
"properties": {
"companyDetails": {
"businessPhone": "string",
"companyName": "string",
"country": "string",
"domain": "string",
"numberOfEmployees": "int",
"officeAddress": "string"
},
"marketplaceDetails": {
"offerDetails": {
"offerId": "string",
"planId": "string",
"planName": "string",
"publisherId": "string",
"termId": "string",
"termUnit": "string"
},
"subscriptionId": "string",
"subscriptionStatus": "string"
},
"partnerOrganizationProperties": {
"organizationId": "string",
"organizationName": "string",
"singleSignOnProperties": {
"aadDomains": [ "string" ],
"enterpriseAppId": "string",
"singleSignOnState": "string",
"singleSignOnUrl": "string"
}
},
"userDetails": {
"emailAddress": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"upn": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Neon.Postgres/organizations
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-12-22-preview' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 50 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$ (required) |
| properties | The resource-specific properties for this resource. | LiftrBaseDataOrganizationProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Neon.Postgres/organizations' |
LiftrBaseCompanyDetails
| Name | Description | Value |
|---|---|---|
| businessPhone | Business phone number of the company | string |
| companyName | Company name | string |
| country | Country name of the company | string |
| domain | Domain of the user | string |
| numberOfEmployees | Number of employees in the company | int |
| officeAddress | Office address of the company | string |
LiftrBaseDataOrganizationProperties
| Name | Description | Value |
|---|---|---|
| companyDetails | Details of the company. | LiftrBaseCompanyDetails (required) |
| marketplaceDetails | Marketplace details of the resource. | LiftrBaseMarketplaceDetails (required) |
| partnerOrganizationProperties | Neon Organization properties | LiftrBaseDataPartnerOrganizationProperties |
| userDetails | Details of the user. | LiftrBaseUserDetails (required) |
LiftrBaseDataPartnerOrganizationProperties
| Name | Description | Value |
|---|---|---|
| organizationId | Organization Id in partner's system | string |
| organizationName | Organization name in partner's system | string Constraints: Min length = 1 Max length = 50 Pattern = ^\S.{0,62}\S$|^\S$ (required) |
| singleSignOnProperties | Single Sign On properties for the organization | LiftrBaseSingleSignOnProperties |
LiftrBaseMarketplaceDetails
| Name | Description | Value |
|---|---|---|
| offerDetails | Offer details for the marketplace that is selected by the user | LiftrBaseOfferDetails (required) |
| subscriptionId | SaaS subscription id for the the marketplace offer | string |
| subscriptionStatus | Marketplace subscription status | 'PendingFulfillmentStart' 'Subscribed' 'Suspended' 'Unsubscribed' |
LiftrBaseOfferDetails
| Name | Description | Value |
|---|---|---|
| offerId | Offer Id for the marketplace offer | string (required) |
| planId | Plan Id for the marketplace offer | string (required) |
| planName | Plan Name for the marketplace offer | string |
| publisherId | Publisher Id for the marketplace offer | string (required) |
| termId | Term Id for the marketplace offer | string |
| termUnit | Term Name for the marketplace offer | string |
LiftrBaseSingleSignOnProperties
| Name | Description | Value |
|---|---|---|
| aadDomains | List of AAD domains fetched from Microsoft Graph for user. | string[] |
| enterpriseAppId | AAD enterprise application Id used to setup SSO | string |
| singleSignOnState | State of the Single Sign On for the organization | 'Disable' 'Enable' 'Initial' |
| singleSignOnUrl | URL for SSO to be used by the partner to redirect the user to their system | string |
LiftrBaseUserDetails
| Name | Description | Value |
|---|---|---|
| emailAddress | Email address of the user | string Constraints: Pattern = ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$ |
| firstName | First name of the user | string |
| lastName | Last name of the user | string |
| phoneNumber | User's phone number | string |
| upn | User's principal name | string |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The organizations resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Neon.Postgres/organizations resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Neon.Postgres/organizations@2024-12-22-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
companyDetails = {
businessPhone = "string"
companyName = "string"
country = "string"
domain = "string"
numberOfEmployees = int
officeAddress = "string"
}
marketplaceDetails = {
offerDetails = {
offerId = "string"
planId = "string"
planName = "string"
publisherId = "string"
termId = "string"
termUnit = "string"
}
subscriptionId = "string"
subscriptionStatus = "string"
}
partnerOrganizationProperties = {
organizationId = "string"
organizationName = "string"
singleSignOnProperties = {
aadDomains = [
"string"
]
enterpriseAppId = "string"
singleSignOnState = "string"
singleSignOnUrl = "string"
}
}
userDetails = {
emailAddress = "string"
firstName = "string"
lastName = "string"
phoneNumber = "string"
upn = "string"
}
}
}
}
Property Values
Neon.Postgres/organizations
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 50 Pattern = ^[a-zA-Z0-9][a-zA-Z0-9_\-.: ]*$ (required) |
| properties | The resource-specific properties for this resource. | LiftrBaseDataOrganizationProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Neon.Postgres/organizations@2024-12-22-preview" |
LiftrBaseCompanyDetails
| Name | Description | Value |
|---|---|---|
| businessPhone | Business phone number of the company | string |
| companyName | Company name | string |
| country | Country name of the company | string |
| domain | Domain of the user | string |
| numberOfEmployees | Number of employees in the company | int |
| officeAddress | Office address of the company | string |
LiftrBaseDataOrganizationProperties
| Name | Description | Value |
|---|---|---|
| companyDetails | Details of the company. | LiftrBaseCompanyDetails (required) |
| marketplaceDetails | Marketplace details of the resource. | LiftrBaseMarketplaceDetails (required) |
| partnerOrganizationProperties | Neon Organization properties | LiftrBaseDataPartnerOrganizationProperties |
| userDetails | Details of the user. | LiftrBaseUserDetails (required) |
LiftrBaseDataPartnerOrganizationProperties
| Name | Description | Value |
|---|---|---|
| organizationId | Organization Id in partner's system | string |
| organizationName | Organization name in partner's system | string Constraints: Min length = 1 Max length = 50 Pattern = ^\S.{0,62}\S$|^\S$ (required) |
| singleSignOnProperties | Single Sign On properties for the organization | LiftrBaseSingleSignOnProperties |
LiftrBaseMarketplaceDetails
| Name | Description | Value |
|---|---|---|
| offerDetails | Offer details for the marketplace that is selected by the user | LiftrBaseOfferDetails (required) |
| subscriptionId | SaaS subscription id for the the marketplace offer | string |
| subscriptionStatus | Marketplace subscription status | 'PendingFulfillmentStart' 'Subscribed' 'Suspended' 'Unsubscribed' |
LiftrBaseOfferDetails
| Name | Description | Value |
|---|---|---|
| offerId | Offer Id for the marketplace offer | string (required) |
| planId | Plan Id for the marketplace offer | string (required) |
| planName | Plan Name for the marketplace offer | string |
| publisherId | Publisher Id for the marketplace offer | string (required) |
| termId | Term Id for the marketplace offer | string |
| termUnit | Term Name for the marketplace offer | string |
LiftrBaseSingleSignOnProperties
| Name | Description | Value |
|---|---|---|
| aadDomains | List of AAD domains fetched from Microsoft Graph for user. | string[] |
| enterpriseAppId | AAD enterprise application Id used to setup SSO | string |
| singleSignOnState | State of the Single Sign On for the organization | 'Disable' 'Enable' 'Initial' |
| singleSignOnUrl | URL for SSO to be used by the partner to redirect the user to their system | string |
LiftrBaseUserDetails
| Name | Description | Value |
|---|---|---|
| emailAddress | Email address of the user | string Constraints: Pattern = ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$ |
| firstName | First name of the user | string |
| lastName | Last name of the user | string |
| phoneNumber | User's phone number | string |
| upn | User's principal name | string |
TrackedResourceTags
| Name | Description | Value |
|---|