Sdílet prostřednictvím


Microsoft.DBforPostgreSQL serverGroupsv2

Definice prostředku Bicep

Typ prostředku serverGroupsv2 je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DBforPostgreSQL/serverGroupsv2, přidejte do šablony následující bicep.

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'
  }
}

Hodnoty vlastností

Microsoft.DBforPostgreSQL/serverGroupsv2

Jméno Popis Hodnota
identita Popisuje identitu clusteru. identityproperties
poloha Geografické umístění, ve kterém se nachází zdroj string (povinné)
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 3
Maximální délka = 40
Model = ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$ (povinné)
vlastnosti Vlastnosti clusteru clusteru
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách

Konfigurace oprávnění

Jméno Popis Hodnota
activeDirectoryAuth Zakázáno
Povoleno
passwordAuth Zakázáno
Povoleno

Vlastnosti clusteru

Jméno Popis Hodnota
administratorLoginPassword Heslo pro přihlášení správce. Vyžaduje se k vytvoření. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
Konfigurace authConfig Konfigurace ověřování clusteru Konfigurace oprávnění
citusVersion Verze rozšíření Citus na všech serverech clusteru. řetězec
coordinatorEnablePublicIpAccess Pokud je pro koordinátora povolený veřejný přístup. Bool
coordinatorServerEdition Edice koordinačního serveru (výchozí hodnota: GeneralPurpose). Vyžaduje se k vytvoření. řetězec
coordinatorStorageQuotaInMb Úložiště serveru v MB. Vyžaduje se k vytvoření. Další informace najdete v tématu /azure/cosmos-db/postgresql/resources-compute. Int
koordinátorVCores Počet virtuálních jader serveru (max. 96). Vyžaduje se k vytvoření. Další informace najdete v tématu /azure/cosmos-db/postgresql/resources-compute. Int
název databáze Název databáze clusteru. Podporuje se pouze jedna databáze na cluster. řetězec
dataEncryption Vlastnosti šifrování dat clusteru. Šifrování dat
enableGeoBackup Pokud je zálohování clusteru uloženo v jiné oblasti Azure kromě kopie zálohy uložené v oblasti clusteru. Povoleno pouze v době vytváření clusteru. Bool
enableHa Pokud je pro cluster povolená vysoká dostupnost nebo ne. Bool
enableShardsOnCoordinator Pokud jsou distribuované tabulky umístěny na koordinátoru nebo ne. V clusterech s jedním uzlem by se měl nastavit na true. Po změně hodnoty vyžaduje vyrovnávání horizontálního dělení. Bool
Okno údržby Časové období údržby clusteru Okno údržby
Počet uzlů Počet pracovních uzlů clusteru Pokud je počet uzlů 0, představuje konfiguraci jednoho uzlu s možností vytvářet distribuované tabulky na daném uzlu. 2 nebo více pracovních uzlů představuje konfiguraci více uzlů. Hodnota počtu uzlů nemůže být 1. Vyžaduje se k vytvoření. Int
nodeEnablePublicIpAccess Pokud je na pracovních uzlech povolený veřejný přístup. Bool
nodeServerEdition Edice serveru uzlu (výchozí hodnota: MemoryOptimized). řetězec
nodeStorageQuotaInMb Úložiště v MB na každém pracovním uzlu. Další informace najdete v tématu /azure/cosmos-db/postgresql/resources-compute. Int
NodeVCores Výpočetní prostředky ve virtuálních jádrech na každém pracovním uzlu (max. 104). Další informace najdete v tématu /azure/cosmos-db/postgresql/resources-compute. Int
pointInTimeUTC Datum a čas ve formátu UTC (ISO8601) pro obnovení clusteru řetězec
postgresqlVersion Hlavní verze PostgreSQL na všech serverech clusteru. řetězec
preferredPrimaryZone Upřednostňovaná primární zóna dostupnosti (AZ) pro všechny servery clusteru řetězec
sourceLocation Oblast Azure zdrojového clusteru pro clustery replik pro čtení řetězec
ID zdroje ID prostředku zdrojového clusteru pro clustery replik pro čtení. řetězec

Šifrování dat

Jméno Popis Hodnota
primaryKeyUri Identifikátor URI klíče v keyvault pro šifrování dat primárního serveru. řetězec
primaryUserAssignedIdentityId ID prostředku pro identitu přiřazenou uživatelem, která se má použít k šifrování dat primárního serveru. řetězec
typ AzureKeyVault
SystemAssigned

Vlastnosti identity

Jméno Popis Hodnota
typ SystemAssigned
UserAssigned
uživatelem přiřazené identity Sada identit přiřazených uživatelem přidružená k prostředku. Klíče slovníku userAssignedIdentities budou ID prostředků ARM ve formuláři: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Hodnoty slovníku můžou být prázdné objekty ({}) v požadavcích. IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

Jméno Popis Hodnota

Okno údržby

Jméno Popis Hodnota
customWindow Určuje, jestli je povolené vlastní časové období údržby nebo ne. řetězec
denOfWeek Preferovaný den v týdnu pro časové období údržby. Int
startHodina Počáteční hodina v upřednostňovaném dni v týdnu pro časové období údržby Int
startMinute Počáteční minuta v počáteční hodině pro časové období údržby Int

TrackedResourceTags

Jméno Popis Hodnota

Identita přiřazená uživatelem (UserAssignedIdentity)

Jméno Popis Hodnota

Příklady použití

Ukázky Bicep

Základní příklad nasazení clusteru Azure Cosmos DB for PostgreSQL.

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'
  }
}

Definice prostředku šablony ARM

Typ prostředku serverGroupsv2 je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DBforPostgreSQL/serverGroupsv2, přidejte do šablony následující JSON.

{
  "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"
  }
}

Hodnoty vlastností

Microsoft.DBforPostgreSQL/serverGroupsv2

Jméno Popis Hodnota
Verze rozhraní apiVersion Verze rozhraní API 2023-03-02-preview
identita Popisuje identitu clusteru. identityproperties
poloha Geografické umístění, ve kterém se nachází zdroj string (povinné)
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 3
Maximální délka = 40
Model = ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$ (povinné)
vlastnosti Vlastnosti clusteru clusteru
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách
typ Typ prostředku Microsoft.DBforPostgreSQL/serverGroupsv2

Konfigurace oprávnění

Jméno Popis Hodnota
activeDirectoryAuth Zakázáno
Povoleno
passwordAuth Zakázáno
Povoleno

Vlastnosti clusteru

Jméno Popis Hodnota
administratorLoginPassword Heslo pro přihlášení správce. Vyžaduje se k vytvoření. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
Konfigurace authConfig Konfigurace ověřování clusteru Konfigurace oprávnění
citusVersion Verze rozšíření Citus na všech serverech clusteru. řetězec
coordinatorEnablePublicIpAccess Pokud je pro koordinátora povolený veřejný přístup. Bool
coordinatorServerEdition Edice koordinačního serveru (výchozí hodnota: GeneralPurpose). Vyžaduje se k vytvoření. řetězec
coordinatorStorageQuotaInMb Úložiště serveru v MB. Vyžaduje se k vytvoření. Další informace najdete v tématu /azure/cosmos-db/postgresql/resources-compute. Int
koordinátorVCores Počet virtuálních jader serveru (max. 96). Vyžaduje se k vytvoření. Další informace najdete v tématu /azure/cosmos-db/postgresql/resources-compute. Int
název databáze Název databáze clusteru. Podporuje se pouze jedna databáze na cluster. řetězec
dataEncryption Vlastnosti šifrování dat clusteru. Šifrování dat
enableGeoBackup Pokud je zálohování clusteru uloženo v jiné oblasti Azure kromě kopie zálohy uložené v oblasti clusteru. Povoleno pouze v době vytváření clusteru. Bool
enableHa Pokud je pro cluster povolená vysoká dostupnost nebo ne. Bool
enableShardsOnCoordinator Pokud jsou distribuované tabulky umístěny na koordinátoru nebo ne. V clusterech s jedním uzlem by se měl nastavit na true. Po změně hodnoty vyžaduje vyrovnávání horizontálního dělení. Bool
Okno údržby Časové období údržby clusteru Okno údržby
Počet uzlů Počet pracovních uzlů clusteru Pokud je počet uzlů 0, představuje konfiguraci jednoho uzlu s možností vytvářet distribuované tabulky na daném uzlu. 2 nebo více pracovních uzlů představuje konfiguraci více uzlů. Hodnota počtu uzlů nemůže být 1. Vyžaduje se k vytvoření. Int
nodeEnablePublicIpAccess Pokud je na pracovních uzlech povolený veřejný přístup. Bool
nodeServerEdition Edice serveru uzlu (výchozí hodnota: MemoryOptimized). řetězec
nodeStorageQuotaInMb Úložiště v MB na každém pracovním uzlu. Další informace najdete v tématu /azure/cosmos-db/postgresql/resources-compute. Int
NodeVCores Výpočetní prostředky ve virtuálních jádrech na každém pracovním uzlu (max. 104). Další informace najdete v tématu /azure/cosmos-db/postgresql/resources-compute. Int
pointInTimeUTC Datum a čas ve formátu UTC (ISO8601) pro obnovení clusteru řetězec
postgresqlVersion Hlavní verze PostgreSQL na všech serverech clusteru. řetězec
preferredPrimaryZone Upřednostňovaná primární zóna dostupnosti (AZ) pro všechny servery clusteru řetězec
sourceLocation Oblast Azure zdrojového clusteru pro clustery replik pro čtení řetězec
ID zdroje ID prostředku zdrojového clusteru pro clustery replik pro čtení. řetězec

Šifrování dat

Jméno Popis Hodnota
primaryKeyUri Identifikátor URI klíče v keyvault pro šifrování dat primárního serveru. řetězec
primaryUserAssignedIdentityId ID prostředku pro identitu přiřazenou uživatelem, která se má použít k šifrování dat primárního serveru. řetězec
typ AzureKeyVault
SystemAssigned

Vlastnosti identity

Jméno Popis Hodnota
typ SystemAssigned
UserAssigned
uživatelem přiřazené identity Sada identit přiřazených uživatelem přidružená k prostředku. Klíče slovníku userAssignedIdentities budou ID prostředků ARM ve formuláři: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Hodnoty slovníku můžou být prázdné objekty ({}) v požadavcích. IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

Jméno Popis Hodnota

Okno údržby

Jméno Popis Hodnota
customWindow Určuje, jestli je povolené vlastní časové období údržby nebo ne. řetězec
denOfWeek Preferovaný den v týdnu pro časové období údržby. Int
startHodina Počáteční hodina v upřednostňovaném dni v týdnu pro časové období údržby Int
startMinute Počáteční minuta v počáteční hodině pro časové období údržby Int

TrackedResourceTags

Jméno Popis Hodnota

Identita přiřazená uživatelem (UserAssignedIdentity)

Jméno Popis Hodnota

Příklady použití

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku serverGroupsv2 je možné nasadit s operacemi, které cílí:

  • skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DBforPostgreSQL/serverGroupsv2, přidejte do šablony následující Terraform.

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"
    }
  }
}

Hodnoty vlastností

Microsoft.DBforPostgreSQL/serverGroupsv2

Jméno Popis Hodnota
identita Popisuje identitu clusteru. identityproperties
poloha Geografické umístění, ve kterém se nachází zdroj string (povinné)
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 3
Maximální délka = 40
Model = ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?<!-)$ (povinné)
vlastnosti Vlastnosti clusteru clusteru
visačky Značky prostředků Slovník názvů a hodnot značek
typ Typ prostředku Microsoft.DBforPostgreSQL/serverGroupsv2@2023-03-02-preview

Konfigurace oprávnění

Jméno Popis Hodnota
activeDirectoryAuth Zakázáno
Povoleno
passwordAuth Zakázáno
Povoleno

Vlastnosti clusteru

Jméno Popis Hodnota
administratorLoginPassword Heslo pro přihlášení správce. Vyžaduje se k vytvoření. řetězec

Omezení:
Citlivá hodnota. Předejte ho jako zabezpečený parametr.
Konfigurace authConfig Konfigurace ověřování clusteru Konfigurace oprávnění
citusVersion Verze rozšíření Citus na všech serverech clusteru. řetězec
coordinatorEnablePublicIpAccess Pokud je pro koordinátora povolený veřejný přístup. Bool
coordinatorServerEdition Edice koordinačního serveru (výchozí hodnota: GeneralPurpose). Vyžaduje se k vytvoření. řetězec
coordinatorStorageQuotaInMb Úložiště serveru v MB. Vyžaduje se k vytvoření. Další informace najdete v tématu /azure/cosmos-db/postgresql/resources-compute. Int
koordinátorVCores Počet virtuálních jader serveru (max. 96). Vyžaduje se k vytvoření. Další informace najdete v tématu /azure/cosmos-db/postgresql/resources-compute. Int
název databáze Název databáze clusteru. Podporuje se pouze jedna databáze na cluster. řetězec
dataEncryption Vlastnosti šifrování dat clusteru. Šifrování dat
enableGeoBackup Pokud je zálohování clusteru uloženo v jiné oblasti Azure kromě kopie zálohy uložené v oblasti clusteru. Povoleno pouze v době vytváření clusteru. Bool
enableHa Pokud je pro cluster povolená vysoká dostupnost nebo ne. Bool
enableShardsOnCoordinator Pokud jsou distribuované tabulky umístěny na koordinátoru nebo ne. V clusterech s jedním uzlem by se měl nastavit na true. Po změně hodnoty vyžaduje vyrovnávání horizontálního dělení. Bool
Okno údržby Časové období údržby clusteru Okno údržby
Počet uzlů Počet pracovních uzlů clusteru Pokud je počet uzlů 0, představuje konfiguraci jednoho uzlu s možností vytvářet distribuované tabulky na daném uzlu. 2 nebo více pracovních uzlů představuje konfiguraci více uzlů. Hodnota počtu uzlů nemůže být 1. Vyžaduje se k vytvoření. Int
nodeEnablePublicIpAccess Pokud je na pracovních uzlech povolený veřejný přístup. Bool
nodeServerEdition Edice serveru uzlu (výchozí hodnota: MemoryOptimized). řetězec
nodeStorageQuotaInMb Úložiště v MB na každém pracovním uzlu. Další informace najdete v tématu /azure/cosmos-db/postgresql/resources-compute. Int
NodeVCores Výpočetní prostředky ve virtuálních jádrech na každém pracovním uzlu (max. 104). Další informace najdete v tématu /azure/cosmos-db/postgresql/resources-compute. Int
pointInTimeUTC Datum a čas ve formátu UTC (ISO8601) pro obnovení clusteru řetězec
postgresqlVersion Hlavní verze PostgreSQL na všech serverech clusteru. řetězec
preferredPrimaryZone Upřednostňovaná primární zóna dostupnosti (AZ) pro všechny servery clusteru řetězec
sourceLocation Oblast Azure zdrojového clusteru pro clustery replik pro čtení řetězec
ID zdroje ID prostředku zdrojového clusteru pro clustery replik pro čtení. řetězec

Šifrování dat

Jméno Popis Hodnota
primaryKeyUri Identifikátor URI klíče v keyvault pro šifrování dat primárního serveru. řetězec
primaryUserAssignedIdentityId ID prostředku pro identitu přiřazenou uživatelem, která se má použít k šifrování dat primárního serveru. řetězec
typ AzureKeyVault
SystemAssigned

Vlastnosti identity

Jméno Popis Hodnota
typ SystemAssigned
UserAssigned
uživatelem přiřazené identity Sada identit přiřazených uživatelem přidružená k prostředku. Klíče slovníku userAssignedIdentities budou ID prostředků ARM ve formuláři: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Hodnoty slovníku můžou být prázdné objekty ({}) v požadavcích. IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

Jméno Popis Hodnota

Okno údržby

Jméno Popis Hodnota
customWindow Určuje, jestli je povolené vlastní časové období údržby nebo ne. řetězec
denOfWeek Preferovaný den v týdnu pro časové období údržby. Int
startHodina Počáteční hodina v upřednostňovaném dni v týdnu pro časové období údržby Int
startMinute Počáteční minuta v počáteční hodině pro časové období údržby Int

TrackedResourceTags

Jméno Popis Hodnota

Identita přiřazená uživatelem (UserAssignedIdentity)

Jméno Popis Hodnota

Příklady použití

Ukázky Terraformu

Základní příklad nasazení clusteru Azure Cosmos DB for PostgreSQL.

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    = ["*"]
}