organizations

Creates, updates, deletes, gets or lists an organizations resource.

Overview

Name	organizations
Type	Resource
Id	azure_isv.neonpostgres.organizations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
companyDetails	object	Details of the company. Required.
location	string	The geo-location where the resource lives. Required.
marketplaceDetails	object	Marketplace details of the resource. Required.
partnerOrganizationProperties	object	Neon Organization properties.
projectProperties	object	Neon Project Properties.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userDetails	object	Details of the user. Required.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
companyDetails	object	Details of the company. Required.
location	string	The geo-location where the resource lives. Required.
marketplaceDetails	object	Marketplace details of the resource. Required.
partnerOrganizationProperties	object	Neon Organization properties.
projectProperties	object	Neon Project Properties.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userDetails	object	Details of the user. Required.

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
companyDetails	object	Details of the company. Required.
location	string	The geo-location where the resource lives. Required.
marketplaceDetails	object	Marketplace details of the resource. Required.
partnerOrganizationProperties	object	Neon Organization properties.
projectProperties	object	Neon Project Properties.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", and "Canceled". (Succeeded, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userDetails	object	Details of the user. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, organization_name, subscription_id		Get a OrganizationResource.
list_by_resource_group	select	resource_group_name, subscription_id		List OrganizationResource resources by resource group.
list_by_subscription	select	subscription_id		List OrganizationResource resources by subscription ID.
create_or_update	insert	resource_group_name, organization_name, subscription_id, location		Create a OrganizationResource.
update	update	resource_group_name, organization_name, subscription_id, location		Update a OrganizationResource.
create_or_update	replace	resource_group_name, organization_name, subscription_id, location		Create a OrganizationResource.
delete	delete	resource_group_name, organization_name, subscription_id		Delete a OrganizationResource.
get_postgres_versions	exec	resource_group_name, subscription_id		Action to retrieve the PostgreSQL versions.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
organization_name	string	Name of the Neon Organizations resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a OrganizationResource.

SELECT
id,
name,
companyDetails,
location,
marketplaceDetails,
partnerOrganizationProperties,
projectProperties,
provisioningState,
systemData,
tags,
type,
userDetails
FROM azure_isv.neonpostgres.organizations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND organization_name = '{{ organization_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List OrganizationResource resources by resource group.

SELECT
id,
name,
companyDetails,
location,
marketplaceDetails,
partnerOrganizationProperties,
projectProperties,
provisioningState,
systemData,
tags,
type,
userDetails
FROM azure_isv.neonpostgres.organizations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List OrganizationResource resources by subscription ID.

SELECT
id,
name,
companyDetails,
location,
marketplaceDetails,
partnerOrganizationProperties,
projectProperties,
provisioningState,
systemData,
tags,
type,
userDetails
FROM azure_isv.neonpostgres.organizations
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a OrganizationResource.

INSERT INTO azure_isv.neonpostgres.organizations (
tags,
location,
properties,
resource_group_name,
organization_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ organization_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: organizations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the organizations resource.
  - name: organization_name
    value: "{{ organization_name }}"
    description: Required parameter for the organizations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the organizations resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      marketplaceDetails:
        subscriptionId: "{{ subscriptionId }}"
        subscriptionStatus: "{{ subscriptionStatus }}"
        offerDetails:
          publisherId: "{{ publisherId }}"
          offerId: "{{ offerId }}"
          planId: "{{ planId }}"
          planName: "{{ planName }}"
          termUnit: "{{ termUnit }}"
          termId: "{{ termId }}"
      userDetails:
        firstName: "{{ firstName }}"
        lastName: "{{ lastName }}"
        emailAddress: "{{ emailAddress }}"
        upn: "{{ upn }}"
        phoneNumber: "{{ phoneNumber }}"
      companyDetails:
        companyName: "{{ companyName }}"
        country: "{{ country }}"
        officeAddress: "{{ officeAddress }}"
        businessPhone: "{{ businessPhone }}"
        domain: "{{ domain }}"
        numberOfEmployees: {{ numberOfEmployees }}
      provisioningState: "{{ provisioningState }}"
      partnerOrganizationProperties:
        organizationId: "{{ organizationId }}"
        organizationName: "{{ organizationName }}"
        singleSignOnProperties:
          singleSignOnState: "{{ singleSignOnState }}"
          enterpriseAppId: "{{ enterpriseAppId }}"
          singleSignOnUrl: "{{ singleSignOnUrl }}"
          aadDomains:
            - "{{ aadDomains }}"
      projectProperties:
        entityId: "{{ entityId }}"
        entityName: "{{ entityName }}"
        createdAt: "{{ createdAt }}"
        provisioningState: "{{ provisioningState }}"
        attributes:
          - name: "{{ name }}"
            value: "{{ value }}"
        regionId: "{{ regionId }}"
        storage: {{ storage }}
        pgVersion: {{ pgVersion }}
        historyRetention: {{ historyRetention }}
        defaultEndpointSettings:
          autoscalingLimitMinCu: {{ autoscalingLimitMinCu }}
          autoscalingLimitMaxCu: {{ autoscalingLimitMaxCu }}
        branch:
          entityId: "{{ entityId }}"
          entityName: "{{ entityName }}"
          createdAt: "{{ createdAt }}"
          provisioningState: "{{ provisioningState }}"
          attributes:
            - name: "{{ name }}"
              value: "{{ value }}"
          projectId: "{{ projectId }}"
          parentId: "{{ parentId }}"
          roleName: "{{ roleName }}"
          databaseName: "{{ databaseName }}"
          roles:
            - entityId: "{{ entityId }}"
              entityName: "{{ entityName }}"
              createdAt: "{{ createdAt }}"
              provisioningState: "{{ provisioningState }}"
              attributes: "{{ attributes }}"
              branchId: "{{ branchId }}"
              permissions: "{{ permissions }}"
              isSuperUser: {{ isSuperUser }}
          databases:
            - entityId: "{{ entityId }}"
              entityName: "{{ entityName }}"
              createdAt: "{{ createdAt }}"
              provisioningState: "{{ provisioningState }}"
              attributes: "{{ attributes }}"
              branchId: "{{ branchId }}"
              ownerName: "{{ ownerName }}"
          endpoints:
            - entityId: "{{ entityId }}"
              entityName: "{{ entityName }}"
              createdAt: "{{ createdAt }}"
              provisioningState: "{{ provisioningState }}"
              attributes: "{{ attributes }}"
              projectId: "{{ projectId }}"
              branchId: "{{ branchId }}"
              endpointType: "{{ endpointType }}"
        roles:
          - entityId: "{{ entityId }}"
            entityName: "{{ entityName }}"
            createdAt: "{{ createdAt }}"
            provisioningState: "{{ provisioningState }}"
            attributes: "{{ attributes }}"
            branchId: "{{ branchId }}"
            permissions: "{{ permissions }}"
            isSuperUser: {{ isSuperUser }}
        databases:
          - entityId: "{{ entityId }}"
            entityName: "{{ entityName }}"
            createdAt: "{{ createdAt }}"
            provisioningState: "{{ provisioningState }}"
            attributes: "{{ attributes }}"
            branchId: "{{ branchId }}"
            ownerName: "{{ ownerName }}"
        endpoints:
          - entityId: "{{ entityId }}"
            entityName: "{{ entityName }}"
            createdAt: "{{ createdAt }}"
            provisioningState: "{{ provisioningState }}"
            attributes: "{{ attributes }}"
            projectId: "{{ projectId }}"
            branchId: "{{ branchId }}"
            endpointType: "{{ endpointType }}"

UPDATE examples

update

Update a OrganizationResource.

UPDATE azure_isv.neonpostgres.organizations
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND organization_name = '{{ organization_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a OrganizationResource.

REPLACE azure_isv.neonpostgres.organizations
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND organization_name = '{{ organization_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a OrganizationResource.

DELETE FROM azure_isv.neonpostgres.organizations
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND organization_name = '{{ organization_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_postgres_versions

Action to retrieve the PostgreSQL versions.

EXEC azure_isv.neonpostgres.organizations.get_postgres_versions 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"version": {{ version }}
}'
;