Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. dbforpostgresql
  5. getServerGroupCluster
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.dbforpostgresql.getServerGroupCluster

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time.

    Uses Azure REST API version 2023-03-02-preview.

    Other available API versions: 2022-11-08. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native dbforpostgresql [ApiVersion]. See the version guide for details.

    Using getServerGroupCluster

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getServerGroupCluster(args: GetServerGroupClusterArgs, opts?: InvokeOptions): Promise<GetServerGroupClusterResult>
function getServerGroupClusterOutput(args: GetServerGroupClusterOutputArgs, opts?: InvokeOptions): Output<GetServerGroupClusterResult>
    def get_server_group_cluster(cluster_name: Optional[str] = None,
                             resource_group_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetServerGroupClusterResult
def get_server_group_cluster_output(cluster_name: Optional[pulumi.Input[str]] = None,
                             resource_group_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetServerGroupClusterResult]
    func LookupServerGroupCluster(ctx *Context, args *LookupServerGroupClusterArgs, opts ...InvokeOption) (*LookupServerGroupClusterResult, error)
func LookupServerGroupClusterOutput(ctx *Context, args *LookupServerGroupClusterOutputArgs, opts ...InvokeOption) LookupServerGroupClusterResultOutput

    > Note: This function is named LookupServerGroupCluster in the Go SDK.

    public static class GetServerGroupCluster 
{
    public static Task<GetServerGroupClusterResult> InvokeAsync(GetServerGroupClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetServerGroupClusterResult> Invoke(GetServerGroupClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetServerGroupClusterResult> getServerGroupCluster(GetServerGroupClusterArgs args, InvokeOptions options)
public static Output<GetServerGroupClusterResult> getServerGroupCluster(GetServerGroupClusterArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:dbforpostgresql:getServerGroupCluster
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterName string
    The name of the cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ClusterName string
    The name of the cluster.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    clusterName String
    The name of the cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    clusterName string
    The name of the cluster.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    cluster_name str
    The name of the cluster.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    clusterName String
    The name of the cluster.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getServerGroupCluster Result

    The following output properties are available:

    AadAuthEnabled string
    Indicates whether the cluster was created using AAD authentication.
    AdministratorLogin string
    The administrator's login name of the servers in the cluster.
    AzureApiVersion string
    The Azure API version of the resource.
    EarliestRestoreTime string
    The earliest restore point time (ISO8601 format) for the cluster.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    PasswordEnabled string
    Indicates whether the cluster was created with a password or using AAD authentication.
    PrivateEndpointConnections List<Pulumi.AzureNative.DBforPostgreSQL.Outputs.SimplePrivateEndpointConnectionResponse>
    The private endpoint connections for a cluster.
    ProvisioningState string
    Provisioning state of the cluster
    ReadReplicas List<string>
    The array of read replica clusters.
    ServerNames List<Pulumi.AzureNative.DBforPostgreSQL.Outputs.ServerNameItemResponse>
    The list of server names in the cluster
    State string
    A state of a cluster/server that is visible to user.
    SystemData Pulumi.AzureNative.DBforPostgreSQL.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AuthConfig Pulumi.AzureNative.DBforPostgreSQL.Outputs.ServerGroupClusterAuthConfigResponse
    Authentication configuration of a cluster.
    CitusVersion string
    The Citus extension version on all cluster servers.
    CoordinatorEnablePublicIpAccess bool
    If public access is enabled on coordinator.
    CoordinatorServerEdition string
    The edition of a coordinator server (default: GeneralPurpose). Required for creation.
    CoordinatorStorageQuotaInMb int
    The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    CoordinatorVCores int
    The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    DataEncryption Pulumi.AzureNative.DBforPostgreSQL.Outputs.ServerGroupClusterDataEncryptionResponse
    The data encryption properties of a cluster.
    DatabaseName string
    The database name of the cluster. Only one database per cluster is supported.
    EnableGeoBackup bool
    If cluster backup is stored in another Azure region in addition to the copy of the backup stored in the cluster's region. Enabled only at the time of cluster creation.
    EnableHa bool
    If high availability (HA) is enabled or not for the cluster.
    EnableShardsOnCoordinator bool
    If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed.
    Identity Pulumi.AzureNative.DBforPostgreSQL.Outputs.IdentityPropertiesResponse
    Describes the identity of the cluster.
    MaintenanceWindow Pulumi.AzureNative.DBforPostgreSQL.Outputs.ServerGroupClusterMaintenanceWindowResponse
    Maintenance window of a cluster.
    NodeCount int
    Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation.
    NodeEnablePublicIpAccess bool
    If public access is enabled on worker nodes.
    NodeServerEdition string
    The edition of a node server (default: MemoryOptimized).
    NodeStorageQuotaInMb int
    The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    NodeVCores int
    The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    PointInTimeUTC string
    Date and time in UTC (ISO8601 format) for cluster restore.
    PostgresqlVersion string
    The major PostgreSQL version on all cluster servers.
    PreferredPrimaryZone string
    Preferred primary availability zone (AZ) for all cluster servers.
    SourceLocation string
    The Azure region of source cluster for read replica clusters.
    SourceResourceId string
    The resource id of source cluster for read replica clusters.
    Tags Dictionary<string, string>
    Resource tags.
    AadAuthEnabled string
    Indicates whether the cluster was created using AAD authentication.
    AdministratorLogin string
    The administrator's login name of the servers in the cluster.
    AzureApiVersion string
    The Azure API version of the resource.
    EarliestRestoreTime string
    The earliest restore point time (ISO8601 format) for the cluster.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    PasswordEnabled string
    Indicates whether the cluster was created with a password or using AAD authentication.
    PrivateEndpointConnections []SimplePrivateEndpointConnectionResponse
    The private endpoint connections for a cluster.
    ProvisioningState string
    Provisioning state of the cluster
    ReadReplicas []string
    The array of read replica clusters.
    ServerNames []ServerNameItemResponse
    The list of server names in the cluster
    State string
    A state of a cluster/server that is visible to user.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    AuthConfig ServerGroupClusterAuthConfigResponse
    Authentication configuration of a cluster.
    CitusVersion string
    The Citus extension version on all cluster servers.
    CoordinatorEnablePublicIpAccess bool
    If public access is enabled on coordinator.
    CoordinatorServerEdition string
    The edition of a coordinator server (default: GeneralPurpose). Required for creation.
    CoordinatorStorageQuotaInMb int
    The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    CoordinatorVCores int
    The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    DataEncryption ServerGroupClusterDataEncryptionResponse
    The data encryption properties of a cluster.
    DatabaseName string
    The database name of the cluster. Only one database per cluster is supported.
    EnableGeoBackup bool
    If cluster backup is stored in another Azure region in addition to the copy of the backup stored in the cluster's region. Enabled only at the time of cluster creation.
    EnableHa bool
    If high availability (HA) is enabled or not for the cluster.
    EnableShardsOnCoordinator bool
    If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed.
    Identity IdentityPropertiesResponse
    Describes the identity of the cluster.
    MaintenanceWindow ServerGroupClusterMaintenanceWindowResponse
    Maintenance window of a cluster.
    NodeCount int
    Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation.
    NodeEnablePublicIpAccess bool
    If public access is enabled on worker nodes.
    NodeServerEdition string
    The edition of a node server (default: MemoryOptimized).
    NodeStorageQuotaInMb int
    The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    NodeVCores int
    The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    PointInTimeUTC string
    Date and time in UTC (ISO8601 format) for cluster restore.
    PostgresqlVersion string
    The major PostgreSQL version on all cluster servers.
    PreferredPrimaryZone string
    Preferred primary availability zone (AZ) for all cluster servers.
    SourceLocation string
    The Azure region of source cluster for read replica clusters.
    SourceResourceId string
    The resource id of source cluster for read replica clusters.
    Tags map[string]string
    Resource tags.
    aadAuthEnabled String
    Indicates whether the cluster was created using AAD authentication.
    administratorLogin String
    The administrator's login name of the servers in the cluster.
    azureApiVersion String
    The Azure API version of the resource.
    earliestRestoreTime String
    The earliest restore point time (ISO8601 format) for the cluster.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    passwordEnabled String
    Indicates whether the cluster was created with a password or using AAD authentication.
    privateEndpointConnections List<SimplePrivateEndpointConnectionResponse>
    The private endpoint connections for a cluster.
    provisioningState String
    Provisioning state of the cluster
    readReplicas List<String>
    The array of read replica clusters.
    serverNames List<ServerNameItemResponse>
    The list of server names in the cluster
    state String
    A state of a cluster/server that is visible to user.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    authConfig ServerGroupClusterAuthConfigResponse
    Authentication configuration of a cluster.
    citusVersion String
    The Citus extension version on all cluster servers.
    coordinatorEnablePublicIpAccess Boolean
    If public access is enabled on coordinator.
    coordinatorServerEdition String
    The edition of a coordinator server (default: GeneralPurpose). Required for creation.
    coordinatorStorageQuotaInMb Integer
    The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    coordinatorVCores Integer
    The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    dataEncryption ServerGroupClusterDataEncryptionResponse
    The data encryption properties of a cluster.
    databaseName String
    The database name of the cluster. Only one database per cluster is supported.
    enableGeoBackup Boolean
    If cluster backup is stored in another Azure region in addition to the copy of the backup stored in the cluster's region. Enabled only at the time of cluster creation.
    enableHa Boolean
    If high availability (HA) is enabled or not for the cluster.
    enableShardsOnCoordinator Boolean
    If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed.
    identity IdentityPropertiesResponse
    Describes the identity of the cluster.
    maintenanceWindow ServerGroupClusterMaintenanceWindowResponse
    Maintenance window of a cluster.
    nodeCount Integer
    Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation.
    nodeEnablePublicIpAccess Boolean
    If public access is enabled on worker nodes.
    nodeServerEdition String
    The edition of a node server (default: MemoryOptimized).
    nodeStorageQuotaInMb Integer
    The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    nodeVCores Integer
    The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    pointInTimeUTC String
    Date and time in UTC (ISO8601 format) for cluster restore.
    postgresqlVersion String
    The major PostgreSQL version on all cluster servers.
    preferredPrimaryZone String
    Preferred primary availability zone (AZ) for all cluster servers.
    sourceLocation String
    The Azure region of source cluster for read replica clusters.
    sourceResourceId String
    The resource id of source cluster for read replica clusters.
    tags Map<String,String>
    Resource tags.
    aadAuthEnabled string
    Indicates whether the cluster was created using AAD authentication.
    administratorLogin string
    The administrator's login name of the servers in the cluster.
    azureApiVersion string
    The Azure API version of the resource.
    earliestRestoreTime string
    The earliest restore point time (ISO8601 format) for the cluster.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    passwordEnabled string
    Indicates whether the cluster was created with a password or using AAD authentication.
    privateEndpointConnections SimplePrivateEndpointConnectionResponse[]
    The private endpoint connections for a cluster.
    provisioningState string
    Provisioning state of the cluster
    readReplicas string[]
    The array of read replica clusters.
    serverNames ServerNameItemResponse[]
    The list of server names in the cluster
    state string
    A state of a cluster/server that is visible to user.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    authConfig ServerGroupClusterAuthConfigResponse
    Authentication configuration of a cluster.
    citusVersion string
    The Citus extension version on all cluster servers.
    coordinatorEnablePublicIpAccess boolean
    If public access is enabled on coordinator.
    coordinatorServerEdition string
    The edition of a coordinator server (default: GeneralPurpose). Required for creation.
    coordinatorStorageQuotaInMb number
    The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    coordinatorVCores number
    The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    dataEncryption ServerGroupClusterDataEncryptionResponse
    The data encryption properties of a cluster.
    databaseName string
    The database name of the cluster. Only one database per cluster is supported.
    enableGeoBackup boolean
    If cluster backup is stored in another Azure region in addition to the copy of the backup stored in the cluster's region. Enabled only at the time of cluster creation.
    enableHa boolean
    If high availability (HA) is enabled or not for the cluster.
    enableShardsOnCoordinator boolean
    If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed.
    identity IdentityPropertiesResponse
    Describes the identity of the cluster.
    maintenanceWindow ServerGroupClusterMaintenanceWindowResponse
    Maintenance window of a cluster.
    nodeCount number
    Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation.
    nodeEnablePublicIpAccess boolean
    If public access is enabled on worker nodes.
    nodeServerEdition string
    The edition of a node server (default: MemoryOptimized).
    nodeStorageQuotaInMb number
    The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    nodeVCores number
    The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    pointInTimeUTC string
    Date and time in UTC (ISO8601 format) for cluster restore.
    postgresqlVersion string
    The major PostgreSQL version on all cluster servers.
    preferredPrimaryZone string
    Preferred primary availability zone (AZ) for all cluster servers.
    sourceLocation string
    The Azure region of source cluster for read replica clusters.
    sourceResourceId string
    The resource id of source cluster for read replica clusters.
    tags {[key: string]: string}
    Resource tags.
    aad_auth_enabled str
    Indicates whether the cluster was created using AAD authentication.
    administrator_login str
    The administrator's login name of the servers in the cluster.
    azure_api_version str
    The Azure API version of the resource.
    earliest_restore_time str
    The earliest restore point time (ISO8601 format) for the cluster.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    password_enabled str
    Indicates whether the cluster was created with a password or using AAD authentication.
    private_endpoint_connections Sequence[SimplePrivateEndpointConnectionResponse]
    The private endpoint connections for a cluster.
    provisioning_state str
    Provisioning state of the cluster
    read_replicas Sequence[str]
    The array of read replica clusters.
    server_names Sequence[ServerNameItemResponse]
    The list of server names in the cluster
    state str
    A state of a cluster/server that is visible to user.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    auth_config ServerGroupClusterAuthConfigResponse
    Authentication configuration of a cluster.
    citus_version str
    The Citus extension version on all cluster servers.
    coordinator_enable_public_ip_access bool
    If public access is enabled on coordinator.
    coordinator_server_edition str
    The edition of a coordinator server (default: GeneralPurpose). Required for creation.
    coordinator_storage_quota_in_mb int
    The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    coordinator_v_cores int
    The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    data_encryption ServerGroupClusterDataEncryptionResponse
    The data encryption properties of a cluster.
    database_name str
    The database name of the cluster. Only one database per cluster is supported.
    enable_geo_backup bool
    If cluster backup is stored in another Azure region in addition to the copy of the backup stored in the cluster's region. Enabled only at the time of cluster creation.
    enable_ha bool
    If high availability (HA) is enabled or not for the cluster.
    enable_shards_on_coordinator bool
    If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed.
    identity IdentityPropertiesResponse
    Describes the identity of the cluster.
    maintenance_window ServerGroupClusterMaintenanceWindowResponse
    Maintenance window of a cluster.
    node_count int
    Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation.
    node_enable_public_ip_access bool
    If public access is enabled on worker nodes.
    node_server_edition str
    The edition of a node server (default: MemoryOptimized).
    node_storage_quota_in_mb int
    The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    node_v_cores int
    The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    point_in_time_utc str
    Date and time in UTC (ISO8601 format) for cluster restore.
    postgresql_version str
    The major PostgreSQL version on all cluster servers.
    preferred_primary_zone str
    Preferred primary availability zone (AZ) for all cluster servers.
    source_location str
    The Azure region of source cluster for read replica clusters.
    source_resource_id str
    The resource id of source cluster for read replica clusters.
    tags Mapping[str, str]
    Resource tags.
    aadAuthEnabled String
    Indicates whether the cluster was created using AAD authentication.
    administratorLogin String
    The administrator's login name of the servers in the cluster.
    azureApiVersion String
    The Azure API version of the resource.
    earliestRestoreTime String
    The earliest restore point time (ISO8601 format) for the cluster.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    passwordEnabled String
    Indicates whether the cluster was created with a password or using AAD authentication.
    privateEndpointConnections List<Property Map>
    The private endpoint connections for a cluster.
    provisioningState String
    Provisioning state of the cluster
    readReplicas List<String>
    The array of read replica clusters.
    serverNames List<Property Map>
    The list of server names in the cluster
    state String
    A state of a cluster/server that is visible to user.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    authConfig Property Map
    Authentication configuration of a cluster.
    citusVersion String
    The Citus extension version on all cluster servers.
    coordinatorEnablePublicIpAccess Boolean
    If public access is enabled on coordinator.
    coordinatorServerEdition String
    The edition of a coordinator server (default: GeneralPurpose). Required for creation.
    coordinatorStorageQuotaInMb Number
    The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    coordinatorVCores Number
    The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    dataEncryption Property Map
    The data encryption properties of a cluster.
    databaseName String
    The database name of the cluster. Only one database per cluster is supported.
    enableGeoBackup Boolean
    If cluster backup is stored in another Azure region in addition to the copy of the backup stored in the cluster's region. Enabled only at the time of cluster creation.
    enableHa Boolean
    If high availability (HA) is enabled or not for the cluster.
    enableShardsOnCoordinator Boolean
    If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed.
    identity Property Map
    Describes the identity of the cluster.
    maintenanceWindow Property Map
    Maintenance window of a cluster.
    nodeCount Number
    Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation.
    nodeEnablePublicIpAccess Boolean
    If public access is enabled on worker nodes.
    nodeServerEdition String
    The edition of a node server (default: MemoryOptimized).
    nodeStorageQuotaInMb Number
    The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    nodeVCores Number
    The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
    pointInTimeUTC String
    Date and time in UTC (ISO8601 format) for cluster restore.
    postgresqlVersion String
    The major PostgreSQL version on all cluster servers.
    preferredPrimaryZone String
    Preferred primary availability zone (AZ) for all cluster servers.
    sourceLocation String
    The Azure region of source cluster for read replica clusters.
    sourceResourceId String
    The resource id of source cluster for read replica clusters.
    tags Map<String>
    Resource tags.

    Supporting Types

    IdentityPropertiesResponse

    Type string
    UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.DBforPostgreSQL.Inputs.UserAssignedIdentityResponse>
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    Type string
    UserAssignedIdentities map[string]UserAssignedIdentityResponse
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    type String
    userAssignedIdentities Map<String,UserAssignedIdentityResponse>
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    type string
    userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    type str
    user_assigned_identities Mapping[str, UserAssignedIdentityResponse]
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    type String
    userAssignedIdentities Map<Property Map>
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

    PrivateEndpointPropertyResponse

    Id string
    Resource id of the private endpoint.
    Id string
    Resource id of the private endpoint.
    id String
    Resource id of the private endpoint.
    id string
    Resource id of the private endpoint.
    id str
    Resource id of the private endpoint.
    id String
    Resource id of the private endpoint.

    PrivateLinkServiceConnectionStateResponse

    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval/rejection of the connection.
    Status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval/rejection of the connection.
    Status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval/rejection of the connection.
    status String
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    description string
    The reason for approval/rejection of the connection.
    status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actions_required str
    A message indicating if changes on the service provider require any updates on the consumer.
    description str
    The reason for approval/rejection of the connection.
    status str
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval/rejection of the connection.
    status String
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    ServerGroupClusterAuthConfigResponse

    ServerGroupClusterDataEncryptionResponse

    PrimaryKeyUri string
    URI for the key in keyvault for data encryption of the primary server.
    PrimaryUserAssignedIdentityId string
    Resource Id for the User assigned identity to be used for data encryption of the primary server.
    Type string
    PrimaryKeyUri string
    URI for the key in keyvault for data encryption of the primary server.
    PrimaryUserAssignedIdentityId string
    Resource Id for the User assigned identity to be used for data encryption of the primary server.
    Type string
    primaryKeyUri String
    URI for the key in keyvault for data encryption of the primary server.
    primaryUserAssignedIdentityId String
    Resource Id for the User assigned identity to be used for data encryption of the primary server.
    type String
    primaryKeyUri string
    URI for the key in keyvault for data encryption of the primary server.
    primaryUserAssignedIdentityId string
    Resource Id for the User assigned identity to be used for data encryption of the primary server.
    type string
    primary_key_uri str
    URI for the key in keyvault for data encryption of the primary server.
    primary_user_assigned_identity_id str
    Resource Id for the User assigned identity to be used for data encryption of the primary server.
    type str
    primaryKeyUri String
    URI for the key in keyvault for data encryption of the primary server.
    primaryUserAssignedIdentityId String
    Resource Id for the User assigned identity to be used for data encryption of the primary server.
    type String

    ServerGroupClusterMaintenanceWindowResponse

    CustomWindow string
    Indicates whether custom maintenance window is enabled or not.
    DayOfWeek int
    Preferred day of the week for maintenance window.
    StartHour int
    Start hour within preferred day of the week for maintenance window.
    StartMinute int
    Start minute within the start hour for maintenance window.
    CustomWindow string
    Indicates whether custom maintenance window is enabled or not.
    DayOfWeek int
    Preferred day of the week for maintenance window.
    StartHour int
    Start hour within preferred day of the week for maintenance window.
    StartMinute int
    Start minute within the start hour for maintenance window.
    customWindow String
    Indicates whether custom maintenance window is enabled or not.
    dayOfWeek Integer
    Preferred day of the week for maintenance window.
    startHour Integer
    Start hour within preferred day of the week for maintenance window.
    startMinute Integer
    Start minute within the start hour for maintenance window.
    customWindow string
    Indicates whether custom maintenance window is enabled or not.
    dayOfWeek number
    Preferred day of the week for maintenance window.
    startHour number
    Start hour within preferred day of the week for maintenance window.
    startMinute number
    Start minute within the start hour for maintenance window.
    custom_window str
    Indicates whether custom maintenance window is enabled or not.
    day_of_week int
    Preferred day of the week for maintenance window.
    start_hour int
    Start hour within preferred day of the week for maintenance window.
    start_minute int
    Start minute within the start hour for maintenance window.
    customWindow String
    Indicates whether custom maintenance window is enabled or not.
    dayOfWeek Number
    Preferred day of the week for maintenance window.
    startHour Number
    Start hour within preferred day of the week for maintenance window.
    startMinute Number
    Start minute within the start hour for maintenance window.

    ServerNameItemResponse

    FullyQualifiedDomainName string
    The fully qualified domain name of a server.
    Name string
    The name of a server.
    FullyQualifiedDomainName string
    The fully qualified domain name of a server.
    Name string
    The name of a server.
    fullyQualifiedDomainName String
    The fully qualified domain name of a server.
    name String
    The name of a server.
    fullyQualifiedDomainName string
    The fully qualified domain name of a server.
    name string
    The name of a server.
    fully_qualified_domain_name str
    The fully qualified domain name of a server.
    name str
    The name of a server.
    fullyQualifiedDomainName String
    The fully qualified domain name of a server.
    name String
    The name of a server.

    SimplePrivateEndpointConnectionResponse

    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.DBforPostgreSQL.Inputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    GroupIds List<string>
    Group ids of the private endpoint connection.
    PrivateEndpoint Pulumi.AzureNative.DBforPostgreSQL.Inputs.PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    PrivateLinkServiceConnectionState Pulumi.AzureNative.DBforPostgreSQL.Inputs.PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    GroupIds []string
    Group ids of the private endpoint connection.
    PrivateEndpoint PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    groupIds List<String>
    Group ids of the private endpoint connection.
    privateEndpoint PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    groupIds string[]
    Group ids of the private endpoint connection.
    privateEndpoint PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    group_ids Sequence[str]
    Group ids of the private endpoint connection.
    private_endpoint PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    groupIds List<String>
    Group ids of the private endpoint connection.
    privateEndpoint Property Map
    Private endpoint which the connection belongs to.
    privateLinkServiceConnectionState Property Map
    A collection of information about the state of the connection between service consumer and provider.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    UserAssignedIdentityResponse

    ClientId string
    The client ID of the assigned identity.
    PrincipalId string
    The principal ID of the assigned identity.
    TenantId string
    Tenant id of the server.
    Type string
    the types of identities associated with this resource
    UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.DBforPostgreSQL.Inputs.UserIdentityResponse>
    represents user assigned identities map.
    ClientId string
    The client ID of the assigned identity.
    PrincipalId string
    The principal ID of the assigned identity.
    TenantId string
    Tenant id of the server.
    Type string
    the types of identities associated with this resource
    UserAssignedIdentities map[string]UserIdentityResponse
    represents user assigned identities map.
    clientId String
    The client ID of the assigned identity.
    principalId String
    The principal ID of the assigned identity.
    tenantId String
    Tenant id of the server.
    type String
    the types of identities associated with this resource
    userAssignedIdentities Map<String,UserIdentityResponse>
    represents user assigned identities map.
    clientId string
    The client ID of the assigned identity.
    principalId string
    The principal ID of the assigned identity.
    tenantId string
    Tenant id of the server.
    type string
    the types of identities associated with this resource
    userAssignedIdentities {[key: string]: UserIdentityResponse}
    represents user assigned identities map.
    client_id str
    The client ID of the assigned identity.
    principal_id str
    The principal ID of the assigned identity.
    tenant_id str
    Tenant id of the server.
    type str
    the types of identities associated with this resource
    user_assigned_identities Mapping[str, UserIdentityResponse]
    represents user assigned identities map.
    clientId String
    The client ID of the assigned identity.
    principalId String
    The principal ID of the assigned identity.
    tenantId String
    Tenant id of the server.
    type String
    the types of identities associated with this resource
    userAssignedIdentities Map<Property Map>
    represents user assigned identities map.

    UserIdentityResponse

    ClientId string
    the client identifier of the Service Principal which this identity represents.
    PrincipalId string
    the object identifier of the Service Principal which this identity represents.
    ClientId string
    the client identifier of the Service Principal which this identity represents.
    PrincipalId string
    the object identifier of the Service Principal which this identity represents.
    clientId String
    the client identifier of the Service Principal which this identity represents.
    principalId String
    the object identifier of the Service Principal which this identity represents.
    clientId string
    the client identifier of the Service Principal which this identity represents.
    principalId string
    the object identifier of the Service Principal which this identity represents.
    client_id str
    the client identifier of the Service Principal which this identity represents.
    principal_id str
    the object identifier of the Service Principal which this identity represents.
    clientId String
    the client identifier of the Service Principal which this identity represents.
    principalId String
    the object identifier of the Service Principal which this identity represents.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native