Microsoft.AzureArcData postgresInstances

Bicep resource definition

The postgresInstances 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 Microsoft.AzureArcData/postgresInstances resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.AzureArcData/postgresInstances@2026-03-01-preview' = {
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    admin: 'string'
    basicLoginInformation: {
      password: 'string'
      username: 'string'
    }
    dataControllerId: 'string'
    k8sRaw: any(...)
    lastUploadedDate: 'string'
  }
  sku: {
    capacity: int
    dev: bool
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'Hyperscale'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.AzureArcData/postgresInstances

Name	Description	Value
extendedLocation	The extendedLocation of the resource.	ExtendedLocation
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	null	PostgresInstanceProperties (required)
sku	Resource sku.	PostgresInstanceSku
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

BasicLoginInformation

Name	Description	Value
password	Login password.	string Constraints: Sensitive value. Pass in as a secure parameter.
username	Login username.	string

ExtendedLocation

Name	Description	Value
name	The name of the extended location.	string
type	The type of the extended location.	'CustomLocation'

PostgresInstanceProperties

Name	Description	Value
admin	The instance admin	string
basicLoginInformation	Username and password for basic authentication.	BasicLoginInformation
dataControllerId	The data controller id	string
k8sRaw	The raw kubernetes information	any
lastUploadedDate	Last uploaded date from Kubernetes cluster. Defaults to current date time	string

PostgresInstanceSku

Name	Description	Value
capacity	If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.	int
dev	Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose.	bool
family	If the service has different generations of hardware, for the same SKU, then that can be captured here.	string
name	The name of the SKU. It is typically a letter+number code	string (required)
size	The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.	string
tier	This field is required to be implemented by the Resource Provider if the service has more than one tier.	'Hyperscale'

TrackedResourceTags

Name	Description	Value

ARM template resource definition

The postgresInstances 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.

Usage Examples

Resource format

To create a Microsoft.AzureArcData/postgresInstances resource, add the following JSON to your template.

{
  "type": "Microsoft.AzureArcData/postgresInstances",
  "apiVersion": "2026-03-01-preview",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "admin": "string",
    "basicLoginInformation": {
      "password": "string",
      "username": "string"
    },
    "dataControllerId": "string",
    "k8sRaw": {},
    "lastUploadedDate": "string"
  },
  "sku": {
    "capacity": "int",
    "dev": "bool",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "Hyperscale"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.AzureArcData/postgresInstances

Name	Description	Value
apiVersion	The api version	'2026-03-01-preview'
extendedLocation	The extendedLocation of the resource.	ExtendedLocation
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	null	PostgresInstanceProperties (required)
sku	Resource sku.	PostgresInstanceSku
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.AzureArcData/postgresInstances'

BasicLoginInformation

Name	Description	Value
password	Login password.	string Constraints: Sensitive value. Pass in as a secure parameter.
username	Login username.	string

ExtendedLocation

Name	Description	Value
name	The name of the extended location.	string
type	The type of the extended location.	'CustomLocation'

PostgresInstanceProperties

Name	Description	Value
admin	The instance admin	string
basicLoginInformation	Username and password for basic authentication.	BasicLoginInformation
dataControllerId	The data controller id	string
k8sRaw	The raw kubernetes information	any
lastUploadedDate	Last uploaded date from Kubernetes cluster. Defaults to current date time	string

PostgresInstanceSku

Name	Description	Value
capacity	If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.	int
dev	Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose.	bool
family	If the service has different generations of hardware, for the same SKU, then that can be captured here.	string
name	The name of the SKU. It is typically a letter+number code	string (required)
size	The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.	string
tier	This field is required to be implemented by the Resource Provider if the service has more than one tier.	'Hyperscale'

TrackedResourceTags

Name	Description	Value

Terraform (AzAPI provider) resource definition

The postgresInstances 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 Microsoft.AzureArcData/postgresInstances resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AzureArcData/postgresInstances@2026-03-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      admin = "string"
      basicLoginInformation = {
        password = "string"
        username = "string"
      }
      dataControllerId = "string"
      k8sRaw = ?
      lastUploadedDate = "string"
    }
    sku = {
      capacity = int
      dev = bool
      family = "string"
      name = "string"
      size = "string"
      tier = "Hyperscale"
    }
  }
}

Property Values

Microsoft.AzureArcData/postgresInstances

Name	Description	Value
extendedLocation	The extendedLocation of the resource.	ExtendedLocation
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	null	PostgresInstanceProperties (required)
sku	Resource sku.	PostgresInstanceSku
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.AzureArcData/postgresInstances@2026-03-01-preview"

BasicLoginInformation

Name	Description	Value
password	Login password.	string Constraints: Sensitive value. Pass in as a secure parameter.
username	Login username.	string

ExtendedLocation

Name	Description	Value
name	The name of the extended location.	string
type	The type of the extended location.	'CustomLocation'

PostgresInstanceProperties

Name	Description	Value
admin	The instance admin	string
basicLoginInformation	Username and password for basic authentication.	BasicLoginInformation
dataControllerId	The data controller id	string
k8sRaw	The raw kubernetes information	any
lastUploadedDate	Last uploaded date from Kubernetes cluster. Defaults to current date time	string

PostgresInstanceSku

Name	Description	Value
capacity	If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.	int
dev	Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose.	bool
family	If the service has different generations of hardware, for the same SKU, then that can be captured here.	string
name	The name of the SKU. It is typically a letter+number code	string (required)
size	The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.	string
tier	This field is required to be implemented by the Resource Provider if the service has more than one tier.	'Hyperscale'

TrackedResourceTags

Name	Description	Value

Feedback

Was this page helpful?

Last updated on 2026-01-20

Microsoft.AzureArcData postgresInstances

Bicep resource definition

Resource format

Property Values

Microsoft.AzureArcData/postgresInstances

BasicLoginInformation

ExtendedLocation

PostgresInstanceProperties

PostgresInstanceSku

TrackedResourceTags

ARM template resource definition

Usage Examples

Resource format

Property Values

Microsoft.AzureArcData/postgresInstances

BasicLoginInformation

ExtendedLocation

PostgresInstanceProperties

PostgresInstanceSku

TrackedResourceTags

Terraform (AzAPI provider) resource definition

Resource format

Property Values

Microsoft.AzureArcData/postgresInstances

BasicLoginInformation

ExtendedLocation

PostgresInstanceProperties

PostgresInstanceSku

TrackedResourceTags

Feedback

Additional resources