1. Packages
  2. Azure Native v2
  3. API Docs
  4. dbforpostgresql
  5. getCluster
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.dbforpostgresql.getCluster

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Gets information about a cluster such as compute and storage configuration and cluster lifecycle metadata such as cluster creation date and time. Azure REST API version: 2022-11-08.

Other available API versions: 2023-03-02-preview.

Using getCluster

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 getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
Copy
def get_cluster(cluster_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
Copy
func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput
Copy

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

public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:dbforpostgresql:getCluster
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
clusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the cluster.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getCluster Result

The following output properties are available:

AdministratorLogin string
The administrator's login name of the servers in the cluster.
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
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"
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.
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.
MaintenanceWindow Pulumi.AzureNative.DBforPostgreSQL.Outputs.MaintenanceWindowResponse
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.
AdministratorLogin string
The administrator's login name of the servers in the cluster.
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
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"
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.
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.
MaintenanceWindow MaintenanceWindowResponse
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.
administratorLogin String
The administrator's login name of the servers in the cluster.
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
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"
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.
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.
maintenanceWindow MaintenanceWindowResponse
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.
administratorLogin string
The administrator's login name of the servers in the cluster.
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
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"
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.
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.
maintenanceWindow MaintenanceWindowResponse
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.
administrator_login str
The administrator's login name of the servers in the cluster.
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
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"
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.
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.
maintenance_window MaintenanceWindowResponse
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.
administratorLogin String
The administrator's login name of the servers in the cluster.
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
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"
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.
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.
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

MaintenanceWindowResponse

CustomWindow string
indicates whether custom window is enabled or disabled
DayOfWeek int
day of week for maintenance window
StartHour int
start hour for maintenance window
StartMinute int
start minute for maintenance window
CustomWindow string
indicates whether custom window is enabled or disabled
DayOfWeek int
day of week for maintenance window
StartHour int
start hour for maintenance window
StartMinute int
start minute for maintenance window
customWindow String
indicates whether custom window is enabled or disabled
dayOfWeek Integer
day of week for maintenance window
startHour Integer
start hour for maintenance window
startMinute Integer
start minute for maintenance window
customWindow string
indicates whether custom window is enabled or disabled
dayOfWeek number
day of week for maintenance window
startHour number
start hour for maintenance window
startMinute number
start minute for maintenance window
custom_window str
indicates whether custom window is enabled or disabled
day_of_week int
day of week for maintenance window
start_hour int
start hour for maintenance window
start_minute int
start minute for maintenance window
customWindow String
indicates whether custom window is enabled or disabled
dayOfWeek Number
day of week for maintenance window
startHour Number
start hour for maintenance window
startMinute Number
start minute for maintenance window

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.

ServerNameItemResponse

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

SimplePrivateEndpointConnectionResponse

Id This property is required. string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name This property is required. string
The name of the resource
SystemData This property is required. Pulumi.AzureNative.DBforPostgreSQL.Inputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type This property is required. 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 This property is required. string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name This property is required. string
The name of the resource
SystemData This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type This property is required. 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 This property is required. String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name This property is required. String
The name of the resource
systemData This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. 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 This property is required. string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name This property is required. string
The name of the resource
systemData This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. 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 This property is required. str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name This property is required. str
The name of the resource
system_data This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. 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 This property is required. String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name This property is required. String
The name of the resource
systemData This property is required. Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. 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.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi