servers

Creates, updates, deletes, gets or lists a servers resource.

Overview

Name	servers
Type	Resource
Id	azure.postgresql.servers

Fields

vw_servers

Name	Datatype	Description
administrator_login	text	field from the properties object
administrator_login_password	text	field from the properties object
auth_config	text	field from the properties object
availability_zone	text	field from the properties object
backup	text	field from the properties object
create_mode	text	field from the properties object
data_encryption	text	field from the properties object
fully_qualified_domain_name	text	field from the properties object
high_availability	text	field from the properties object
identity	text	Information describing the identities associated with this application.
location	text	The geo-location where the resource lives
maintenance_window	text	field from the properties object
minor_version	text	field from the properties object
network	text	field from the properties object
point_in_time_utc	text	field from the properties object
private_endpoint_connections	text	field from the properties object
replica	text	field from the properties object
replica_capacity	text	field from the properties object
replication_role	text	field from the properties object
resourceGroupName	text	field from the properties object
serverName	text	field from the properties object
sku	text	Sku information related properties of a server.
source_server_resource_id	text	field from the properties object
state	text	field from the properties object
storage	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
version	text	field from the properties object

servers

Name	Datatype	Description
identity	object	Information describing the identities associated with this application.
location	string	The geo-location where the resource lives
properties	object	The properties of a server.
sku	object	Sku information related properties of a server.
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, serverName, subscriptionId	Gets information about a server.
list	SELECT	subscriptionId	List all the servers in a given subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	List all the servers in a given resource group.
create	INSERT	resourceGroupName, serverName, subscriptionId	Creates a new server.
delete	DELETE	resourceGroupName, serverName, subscriptionId	Deletes a server.
update	UPDATE	resourceGroupName, serverName, subscriptionId	Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.
restart	EXEC	resourceGroupName, serverName, subscriptionId	Restarts a server.
start	EXEC	resourceGroupName, serverName, subscriptionId	Starts a server.
stop	EXEC	resourceGroupName, serverName, subscriptionId	Stops a server.

SELECT examples

List all the servers in a given subscription.

vw_servers

SELECT
administrator_login,
administrator_login_password,
auth_config,
availability_zone,
backup,
create_mode,
data_encryption,
fully_qualified_domain_name,
high_availability,
identity,
location,
maintenance_window,
minor_version,
network,
point_in_time_utc,
private_endpoint_connections,
replica,
replica_capacity,
replication_role,
resourceGroupName,
serverName,
sku,
source_server_resource_id,
state,
storage,
subscriptionId,
tags,
version
FROM azure.postgresql.vw_servers
WHERE subscriptionId = '{{ subscriptionId }}';

servers

SELECT
identity,
location,
properties,
sku,
tags
FROM azure.postgresql.servers
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new servers resource.

All Properties

/*+ create */
INSERT INTO azure.postgresql.servers (
resourceGroupName,
serverName,
subscriptionId,
sku,
identity,
properties,
tags,
location
)
SELECT 
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ subscriptionId }}',
'{{ sku }}',
'{{ identity }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string
    - name: identity
      value:
        - name: userAssignedIdentities
          value: []
        - name: type
          value: string
        - name: tenantId
          value: string
    - name: properties
      value:
        - name: administratorLogin
          value: string
        - name: administratorLoginPassword
          value: string
        - name: version
          value: []
        - name: minorVersion
          value: string
        - name: state
          value: string
        - name: fullyQualifiedDomainName
          value: string
        - name: storage
          value:
            - name: storageSizeGB
              value: integer
            - name: autoGrow
              value: string
            - name: tier
              value: string
            - name: iops
              value: integer
            - name: throughput
              value: integer
            - name: type
              value: string
        - name: authConfig
          value:
            - name: activeDirectoryAuth
              value: string
            - name: passwordAuth
              value: string
            - name: tenantId
              value: string
        - name: dataEncryption
          value:
            - name: primaryKeyURI
              value: string
            - name: primaryUserAssignedIdentityId
              value: string
            - name: geoBackupKeyURI
              value: string
            - name: geoBackupUserAssignedIdentityId
              value: string
            - name: type
              value: string
            - name: primaryEncryptionKeyStatus
              value: string
            - name: geoBackupEncryptionKeyStatus
              value: string
        - name: backup
          value:
            - name: backupRetentionDays
              value: integer
            - name: geoRedundantBackup
              value: string
            - name: earliestRestoreDate
              value: string
        - name: network
          value:
            - name: publicNetworkAccess
              value: string
            - name: delegatedSubnetResourceId
              value: string
            - name: privateDnsZoneArmResourceId
              value: string
        - name: highAvailability
          value:
            - name: mode
              value: string
            - name: state
              value: string
            - name: standbyAvailabilityZone
              value: string
        - name: maintenanceWindow
          value:
            - name: customWindow
              value: string
            - name: startHour
              value: integer
            - name: startMinute
              value: integer
            - name: dayOfWeek
              value: integer
        - name: sourceServerResourceId
          value: string
        - name: pointInTimeUTC
          value: string
        - name: availabilityZone
          value: string
        - name: replicationRole
          value: []
        - name: replicaCapacity
          value: integer
        - name: replica
          value:
            - name: capacity
              value: integer
            - name: replicationState
              value: string
            - name: promoteMode
              value: string
            - name: promoteOption
              value: string
        - name: createMode
          value: string
        - name: privateEndpointConnections
          value:
            - - name: properties
                value:
                  - name: groupIds
                    value:
                      - string
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: status
                        value: []
                      - name: description
                        value: string
                      - name: actionsRequired
                        value: string
                  - name: provisioningState
                    value: []
              - name: id
                value: string
              - name: name
                value: string
              - name: type
                value: string
              - name: systemData
                value:
                  - name: createdBy
                    value: string
                  - name: createdByType
                    value: string
                  - name: createdAt
                    value: string
                  - name: lastModifiedBy
                    value: string
                  - name: lastModifiedByType
                    value: string
                  - name: lastModifiedAt
                    value: string
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a servers resource.

/*+ update */
UPDATE azure.postgresql.servers
SET 
sku = '{{ sku }}',
identity = '{{ identity }}',
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND serverName = '{{ serverName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified servers resource.

/*+ delete */
DELETE FROM azure.postgresql.servers
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serverName = '{{ serverName }}'
AND subscriptionId = '{{ subscriptionId }}';