Dela via


Microsoft.DBforPostgreSQL serverGroupsv2

Bicep-resursdefinition

Resurstypen serverGroupsv2 kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DBforPostgreSQL/serverGroupsv2-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.DBforPostgreSQL/serverGroupsv2@2023-03-02-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    administratorLoginPassword: 'string'
    authConfig: {
      activeDirectoryAuth: 'string'
      passwordAuth: 'string'
    }
    citusVersion: 'string'
    coordinatorEnablePublicIpAccess: bool
    coordinatorServerEdition: 'string'
    coordinatorStorageQuotaInMb: int
    coordinatorVCores: int
    databaseName: 'string'
    dataEncryption: {
      primaryKeyUri: 'string'
      primaryUserAssignedIdentityId: 'string'
      type: 'string'
    }
    enableGeoBackup: bool
    enableHa: bool
    enableShardsOnCoordinator: bool
    maintenanceWindow: {
      customWindow: 'string'
      dayOfWeek: int
      startHour: int
      startMinute: int
    }
    nodeCount: int
    nodeEnablePublicIpAccess: bool
    nodeServerEdition: 'string'
    nodeStorageQuotaInMb: int
    nodeVCores: int
    pointInTimeUTC: 'string'
    postgresqlVersion: 'string'
    preferredPrimaryZone: 'string'
    sourceLocation: 'string'
    sourceResourceId: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Egenskapsvärden

Microsoft.DBforPostgreSQL/serverGroupsv2

Namn Beskrivning Värde
identitet Beskriver klustrets identitet. IdentityProperties (Identitet) Egenskaper
plats Den geo-plats där resursen finns sträng (krävs)
Namn Resursnamnet sträng

Begränsningar:
Min längd = 3
Maximal längd = 40
Mönster = ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$ (krävs)
Egenskaper Egenskaper för klustret. ClusterProperties (KlusterEgenskaper)
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar

AuthConfig

Namn Beskrivning Värde
activeDirectoryAuth "inaktiverad"
"aktiverad"
passwordAuth "inaktiverad"
"aktiverad"

ClusterProperties (KlusterEgenskaper)

Namn Beskrivning Värde
administratörLogga inLösenord Lösenordet för administratörsinloggningen. Krävs för att skapa. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
authConfig Autentiseringskonfiguration för ett kluster. AuthConfig
citusVersion Citus-tilläggsversionen på alla klusterservrar. sträng
coordinatorEnablePublicIpAccess Om offentlig åtkomst är aktiverad på koordinatorn. Bool
coordinatorServerEdition Utgåvan av en koordinatorserver (standard: GeneralPurpose). Krävs för att skapa. sträng
koordinatorStorageQuotaInMb Lagring av en server i MB. Krävs för att skapa. Mer information finns i /azure/cosmos-db/postgresql/resources-compute. Int
koordinatorVCores Antalet virtuella kärnor för en server (max: 96). Krävs för att skapa. Mer information finns i /azure/cosmos-db/postgresql/resources-compute. Int
databasNamn Klustrets databasnamn. Endast en databas per kluster stöds. sträng
dataKryptering Datakrypteringsegenskaperna för ett kluster. DataKryptering
enableGeoBackup Om klustersäkerhetskopiering lagras i en annan Azure-region utöver kopian av säkerhetskopian som lagras i klustrets region. Aktiverad endast när klustret skapas. Bool
enableHa Om hög tillgänglighet (HA) är aktiverat eller inte för klustret. Bool
enableShardsOnCoordinator Om distribuerade tabeller placeras på koordinator eller inte. Ska anges till "true" i kluster med en enda nod. Kräver horisontell ombalansering när värdet har ändrats. Bool
underhållWindow Underhållsperiod för ett kluster. UnderhållWindow
nodeCount (på engelska) Antal arbetsnoder i klustret. När antalet noder är 0 representerar det en konfiguration med en enda nod med möjlighet att skapa distribuerade tabeller på noden. 2 eller fler arbetsnoder representerar konfiguration med flera noder. Värdet för antal noder får inte vara 1. Krävs för att skapa. Int
nodeEnablePublicIpAccess Om offentlig åtkomst är aktiverad på arbetsnoder. Bool
nodeServerEdition Utgåvan av en nodserver (standard: MemoryOptimized). sträng
nodeStorageQuotaInMb Lagringen i MB på varje arbetsnod. Mer information finns i /azure/cosmos-db/postgresql/resources-compute. Int
nodeVCores Beräkningen i virtuella kärnor på varje arbetsnod (max: 104). Mer information finns i /azure/cosmos-db/postgresql/resources-compute. Int
pointInTimeUTC Datum och tid i UTC (ISO8601 format) för klusteråterställning. sträng
postgresqlVersion Den större PostgreSQL-versionen på alla klusterservrar. sträng
preferredPrimaryZone Prioriterad primär tillgänglighetszon (AZ) för alla klusterservrar. sträng
sourceLocation Azure-regionen för källkluster för skrivskyddade replikkluster. sträng
sourceResourceId Resurs-ID för källkluster för skrivskyddade replikkluster. sträng

DataKryptering

Namn Beskrivning Värde
primaryKeyUri URI för nyckeln i keyvault för datakryptering av den primära servern. sträng
primaryUserAssignedIdentityId Resurs-ID för den användartilldelade identitet som ska användas för datakryptering av den primära servern. sträng
typ "AzureKeyVault"
"SystemAssigned"

IdentityProperties (Identitet) Egenskaper

Namn Beskrivning Värde
typ "SystemAssigned"
"UserAssigned"
användartilldelade identiteter Uppsättningen användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden. IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

Namn Beskrivning Värde

UnderhållWindow

Namn Beskrivning Värde
customWindow Anger om fönstret för anpassat underhåll är aktiverat eller inte. sträng
veckodag Önskad dag i veckan för underhållsperiod. Int
starttimme Starttimmes inom önskad dag i veckan för underhållsperiod. Int
startminut Startminut inom starttimmes för underhållsperiod. Int

Spårade resurstaggar

Namn Beskrivning Värde

Användartilldelad identitet

Namn Beskrivning Värde

Användningsexempel

Bicep-exempel

Ett grundläggande exempel på distribution av Azure Cosmos DB för PostgreSQL-kluster.

param resourceName string = 'acctest0001'
param location string = 'westeurope'
@secure()
@description('The administrator login password for the PostgreSQL server group')
param administratorLoginPassword string

resource serverGroupsv2 'Microsoft.DBforPostgreSQL/serverGroupsv2@2022-11-08' = {
  name: resourceName
  location: location
  properties: {
    administratorLoginPassword: null
    coordinatorEnablePublicIpAccess: true
    coordinatorServerEdition: 'GeneralPurpose'
    coordinatorStorageQuotaInMb: 131072
    coordinatorVCores: 2
    enableHa: false
    nodeCount: 0
    nodeEnablePublicIpAccess: false
    nodeServerEdition: 'MemoryOptimized'
  }
}

Resursdefinition för ARM-mall

Resurstypen serverGroupsv2 kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DBforPostgreSQL/serverGroupsv2-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2",
  "apiVersion": "2023-03-02-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "administratorLoginPassword": "string",
    "authConfig": {
      "activeDirectoryAuth": "string",
      "passwordAuth": "string"
    },
    "citusVersion": "string",
    "coordinatorEnablePublicIpAccess": "bool",
    "coordinatorServerEdition": "string",
    "coordinatorStorageQuotaInMb": "int",
    "coordinatorVCores": "int",
    "databaseName": "string",
    "dataEncryption": {
      "primaryKeyUri": "string",
      "primaryUserAssignedIdentityId": "string",
      "type": "string"
    },
    "enableGeoBackup": "bool",
    "enableHa": "bool",
    "enableShardsOnCoordinator": "bool",
    "maintenanceWindow": {
      "customWindow": "string",
      "dayOfWeek": "int",
      "startHour": "int",
      "startMinute": "int"
    },
    "nodeCount": "int",
    "nodeEnablePublicIpAccess": "bool",
    "nodeServerEdition": "string",
    "nodeStorageQuotaInMb": "int",
    "nodeVCores": "int",
    "pointInTimeUTC": "string",
    "postgresqlVersion": "string",
    "preferredPrimaryZone": "string",
    "sourceLocation": "string",
    "sourceResourceId": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Egenskapsvärden

Microsoft.DBforPostgreSQL/serverGroupsv2

Namn Beskrivning Värde
apiVersion API-versionen "2023-03-02-preview"
identitet Beskriver klustrets identitet. IdentityProperties (Identitet) Egenskaper
plats Den geo-plats där resursen finns sträng (krävs)
Namn Resursnamnet sträng

Begränsningar:
Min längd = 3
Maximal längd = 40
Mönster = ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$ (krävs)
Egenskaper Egenskaper för klustret. ClusterProperties (KlusterEgenskaper)
Taggar Resurstaggar Ordlista med taggnamn och värden. Se taggar i mallar
typ Resurstypen "Microsoft.DBforPostgreSQL/serverGroupsv2"

AuthConfig

Namn Beskrivning Värde
activeDirectoryAuth "inaktiverad"
"aktiverad"
passwordAuth "inaktiverad"
"aktiverad"

ClusterProperties (KlusterEgenskaper)

Namn Beskrivning Värde
administratörLogga inLösenord Lösenordet för administratörsinloggningen. Krävs för att skapa. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
authConfig Autentiseringskonfiguration för ett kluster. AuthConfig
citusVersion Citus-tilläggsversionen på alla klusterservrar. sträng
coordinatorEnablePublicIpAccess Om offentlig åtkomst är aktiverad på koordinatorn. Bool
coordinatorServerEdition Utgåvan av en koordinatorserver (standard: GeneralPurpose). Krävs för att skapa. sträng
koordinatorStorageQuotaInMb Lagring av en server i MB. Krävs för att skapa. Mer information finns i /azure/cosmos-db/postgresql/resources-compute. Int
koordinatorVCores Antalet virtuella kärnor för en server (max: 96). Krävs för att skapa. Mer information finns i /azure/cosmos-db/postgresql/resources-compute. Int
databasNamn Klustrets databasnamn. Endast en databas per kluster stöds. sträng
dataKryptering Datakrypteringsegenskaperna för ett kluster. DataKryptering
enableGeoBackup Om klustersäkerhetskopiering lagras i en annan Azure-region utöver kopian av säkerhetskopian som lagras i klustrets region. Aktiverad endast när klustret skapas. Bool
enableHa Om hög tillgänglighet (HA) är aktiverat eller inte för klustret. Bool
enableShardsOnCoordinator Om distribuerade tabeller placeras på koordinator eller inte. Ska anges till "true" i kluster med en enda nod. Kräver horisontell ombalansering när värdet har ändrats. Bool
underhållWindow Underhållsperiod för ett kluster. UnderhållWindow
nodeCount (på engelska) Antal arbetsnoder i klustret. När antalet noder är 0 representerar det en konfiguration med en enda nod med möjlighet att skapa distribuerade tabeller på noden. 2 eller fler arbetsnoder representerar konfiguration med flera noder. Värdet för antal noder får inte vara 1. Krävs för att skapa. Int
nodeEnablePublicIpAccess Om offentlig åtkomst är aktiverad på arbetsnoder. Bool
nodeServerEdition Utgåvan av en nodserver (standard: MemoryOptimized). sträng
nodeStorageQuotaInMb Lagringen i MB på varje arbetsnod. Mer information finns i /azure/cosmos-db/postgresql/resources-compute. Int
nodeVCores Beräkningen i virtuella kärnor på varje arbetsnod (max: 104). Mer information finns i /azure/cosmos-db/postgresql/resources-compute. Int
pointInTimeUTC Datum och tid i UTC (ISO8601 format) för klusteråterställning. sträng
postgresqlVersion Den större PostgreSQL-versionen på alla klusterservrar. sträng
preferredPrimaryZone Prioriterad primär tillgänglighetszon (AZ) för alla klusterservrar. sträng
sourceLocation Azure-regionen för källkluster för skrivskyddade replikkluster. sträng
sourceResourceId Resurs-ID för källkluster för skrivskyddade replikkluster. sträng

DataKryptering

Namn Beskrivning Värde
primaryKeyUri URI för nyckeln i keyvault för datakryptering av den primära servern. sträng
primaryUserAssignedIdentityId Resurs-ID för den användartilldelade identitet som ska användas för datakryptering av den primära servern. sträng
typ "AzureKeyVault"
"SystemAssigned"

IdentityProperties (Identitet) Egenskaper

Namn Beskrivning Värde
typ "SystemAssigned"
"UserAssigned"
användartilldelade identiteter Uppsättningen användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden. IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

Namn Beskrivning Värde

UnderhållWindow

Namn Beskrivning Värde
customWindow Anger om fönstret för anpassat underhåll är aktiverat eller inte. sträng
veckodag Önskad dag i veckan för underhållsperiod. Int
starttimme Starttimmes inom önskad dag i veckan för underhållsperiod. Int
startminut Startminut inom starttimmes för underhållsperiod. Int

Spårade resurstaggar

Namn Beskrivning Värde

Användartilldelad identitet

Namn Beskrivning Värde

Användningsexempel

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen serverGroupsv2 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 Microsoft.DBforPostgreSQL/serverGroupsv2-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforPostgreSQL/serverGroupsv2@2023-03-02-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      administratorLoginPassword = "string"
      authConfig = {
        activeDirectoryAuth = "string"
        passwordAuth = "string"
      }
      citusVersion = "string"
      coordinatorEnablePublicIpAccess = bool
      coordinatorServerEdition = "string"
      coordinatorStorageQuotaInMb = int
      coordinatorVCores = int
      databaseName = "string"
      dataEncryption = {
        primaryKeyUri = "string"
        primaryUserAssignedIdentityId = "string"
        type = "string"
      }
      enableGeoBackup = bool
      enableHa = bool
      enableShardsOnCoordinator = bool
      maintenanceWindow = {
        customWindow = "string"
        dayOfWeek = int
        startHour = int
        startMinute = int
      }
      nodeCount = int
      nodeEnablePublicIpAccess = bool
      nodeServerEdition = "string"
      nodeStorageQuotaInMb = int
      nodeVCores = int
      pointInTimeUTC = "string"
      postgresqlVersion = "string"
      preferredPrimaryZone = "string"
      sourceLocation = "string"
      sourceResourceId = "string"
    }
  }
}

Egenskapsvärden

Microsoft.DBforPostgreSQL/serverGroupsv2

Namn Beskrivning Värde
identitet Beskriver klustrets identitet. IdentityProperties (Identitet) Egenskaper
plats Den geo-plats där resursen finns sträng (krävs)
Namn Resursnamnet sträng

Begränsningar:
Min längd = 3
Maximal längd = 40
Mönster = ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$ (krävs)
Egenskaper Egenskaper för klustret. ClusterProperties (KlusterEgenskaper)
Taggar Resurstaggar Ordlista med taggnamn och värden.
typ Resurstypen "Microsoft.DBforPostgreSQL/serverGroupsv2@2023-03-02-preview" (Microsoft.DBforPostgreSQL/-03-02-preview)

AuthConfig

Namn Beskrivning Värde
activeDirectoryAuth "inaktiverad"
"aktiverad"
passwordAuth "inaktiverad"
"aktiverad"

ClusterProperties (KlusterEgenskaper)

Namn Beskrivning Värde
administratörLogga inLösenord Lösenordet för administratörsinloggningen. Krävs för att skapa. sträng

Begränsningar:
Känsligt värde. Skicka in som en säker parameter.
authConfig Autentiseringskonfiguration för ett kluster. AuthConfig
citusVersion Citus-tilläggsversionen på alla klusterservrar. sträng
coordinatorEnablePublicIpAccess Om offentlig åtkomst är aktiverad på koordinatorn. Bool
coordinatorServerEdition Utgåvan av en koordinatorserver (standard: GeneralPurpose). Krävs för att skapa. sträng
koordinatorStorageQuotaInMb Lagring av en server i MB. Krävs för att skapa. Mer information finns i /azure/cosmos-db/postgresql/resources-compute. Int
koordinatorVCores Antalet virtuella kärnor för en server (max: 96). Krävs för att skapa. Mer information finns i /azure/cosmos-db/postgresql/resources-compute. Int
databasNamn Klustrets databasnamn. Endast en databas per kluster stöds. sträng
dataKryptering Datakrypteringsegenskaperna för ett kluster. DataKryptering
enableGeoBackup Om klustersäkerhetskopiering lagras i en annan Azure-region utöver kopian av säkerhetskopian som lagras i klustrets region. Aktiverad endast när klustret skapas. Bool
enableHa Om hög tillgänglighet (HA) är aktiverat eller inte för klustret. Bool
enableShardsOnCoordinator Om distribuerade tabeller placeras på koordinator eller inte. Ska anges till "true" i kluster med en enda nod. Kräver horisontell ombalansering när värdet har ändrats. Bool
underhållWindow Underhållsperiod för ett kluster. UnderhållWindow
nodeCount (på engelska) Antal arbetsnoder i klustret. När antalet noder är 0 representerar det en konfiguration med en enda nod med möjlighet att skapa distribuerade tabeller på noden. 2 eller fler arbetsnoder representerar konfiguration med flera noder. Värdet för antal noder får inte vara 1. Krävs för att skapa. Int
nodeEnablePublicIpAccess Om offentlig åtkomst är aktiverad på arbetsnoder. Bool
nodeServerEdition Utgåvan av en nodserver (standard: MemoryOptimized). sträng
nodeStorageQuotaInMb Lagringen i MB på varje arbetsnod. Mer information finns i /azure/cosmos-db/postgresql/resources-compute. Int
nodeVCores Beräkningen i virtuella kärnor på varje arbetsnod (max: 104). Mer information finns i /azure/cosmos-db/postgresql/resources-compute. Int
pointInTimeUTC Datum och tid i UTC (ISO8601 format) för klusteråterställning. sträng
postgresqlVersion Den större PostgreSQL-versionen på alla klusterservrar. sträng
preferredPrimaryZone Prioriterad primär tillgänglighetszon (AZ) för alla klusterservrar. sträng
sourceLocation Azure-regionen för källkluster för skrivskyddade replikkluster. sträng
sourceResourceId Resurs-ID för källkluster för skrivskyddade replikkluster. sträng

DataKryptering

Namn Beskrivning Värde
primaryKeyUri URI för nyckeln i keyvault för datakryptering av den primära servern. sträng
primaryUserAssignedIdentityId Resurs-ID för den användartilldelade identitet som ska användas för datakryptering av den primära servern. sträng
typ "AzureKeyVault"
"SystemAssigned"

IdentityProperties (Identitet) Egenskaper

Namn Beskrivning Värde
typ "SystemAssigned"
"UserAssigned"
användartilldelade identiteter Uppsättningen användartilldelade identiteter som är associerade med resursen. Ordlistenycklarna userAssignedIdentities är ARM-resurs-ID:er i formuläret: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Ordlistevärdena kan vara tomma objekt ({}) i begäranden. IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

Namn Beskrivning Värde

UnderhållWindow

Namn Beskrivning Värde
customWindow Anger om fönstret för anpassat underhåll är aktiverat eller inte. sträng
veckodag Önskad dag i veckan för underhållsperiod. Int
starttimme Starttimmes inom önskad dag i veckan för underhållsperiod. Int
startminut Startminut inom starttimmes för underhållsperiod. Int

Spårade resurstaggar

Namn Beskrivning Värde

Användartilldelad identitet

Namn Beskrivning Värde

Användningsexempel

Terraform-exempel

Ett grundläggande exempel på distribution av Azure Cosmos DB för PostgreSQL-kluster.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

variable "administrator_login_password" {
  type        = string
  description = "The administrator login password for the PostgreSQL server group"
  sensitive   = true
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "serverGroupsv2" {
  type      = "Microsoft.DBforPostgreSQL/serverGroupsv2@2022-11-08"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      administratorLoginPassword      = var.administrator_login_password
      coordinatorEnablePublicIpAccess = true
      coordinatorServerEdition        = "GeneralPurpose"
      coordinatorStorageQuotaInMb     = 131072
      coordinatorVCores               = 2
      enableHa                        = false
      nodeCount                       = 0
      nodeEnablePublicIpAccess        = false
      nodeServerEdition               = "MemoryOptimized"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}