1. Packages
  2. Azure Native
  3. API Docs
  4. dbforpostgresql
  5. getServer
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

azure-native.dbforpostgresql.getServer

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

    Gets information about a server.

    Uses Azure REST API version 2024-08-01.

    Other available API versions: 2022-12-01, 2023-03-01-preview, 2023-06-01-preview, 2023-12-01-preview, 2024-03-01-preview, 2024-11-01-preview. 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 getServer

    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 getServer(args: GetServerArgs, opts?: InvokeOptions): Promise<GetServerResult>
    function getServerOutput(args: GetServerOutputArgs, opts?: InvokeOptions): Output<GetServerResult>
    def get_server(resource_group_name: Optional[str] = None,
                   server_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetServerResult
    def get_server_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                   server_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetServerResult]
    func LookupServer(ctx *Context, args *LookupServerArgs, opts ...InvokeOption) (*LookupServerResult, error)
    func LookupServerOutput(ctx *Context, args *LookupServerOutputArgs, opts ...InvokeOption) LookupServerResultOutput

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

    public static class GetServer 
    {
        public static Task<GetServerResult> InvokeAsync(GetServerArgs args, InvokeOptions? opts = null)
        public static Output<GetServerResult> Invoke(GetServerInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetServerResult> getServer(GetServerArgs args, InvokeOptions options)
    public static Output<GetServerResult> getServer(GetServerArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:dbforpostgresql:getServer
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServerName string
    The name of the server.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServerName string
    The name of the server.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serverName String
    The name of the server.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serverName string
    The name of the server.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    server_name str
    The name of the server.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serverName String
    The name of the server.

    getServer Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    FullyQualifiedDomainName string
    The fully qualified domain name of a server.
    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
    MinorVersion string
    The minor version of the server.
    Name string
    The name of the resource
    PrivateEndpointConnections List<Pulumi.AzureNative.DBforPostgreSQL.Outputs.PrivateEndpointConnectionResponse>
    List of private endpoint connections associated with the specified resource.
    ReplicaCapacity int
    Replicas allowed for a server.
    State string
    A state of a 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"
    AdministratorLogin string
    The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).
    AuthConfig Pulumi.AzureNative.DBforPostgreSQL.Outputs.AuthConfigResponse
    AuthConfig properties of a server.
    AvailabilityZone string
    availability zone information of the server.
    Backup Pulumi.AzureNative.DBforPostgreSQL.Outputs.BackupResponse
    Backup properties of a server.
    DataEncryption Pulumi.AzureNative.DBforPostgreSQL.Outputs.DataEncryptionResponse
    Data encryption properties of a server.
    HighAvailability Pulumi.AzureNative.DBforPostgreSQL.Outputs.HighAvailabilityResponse
    High availability properties of a server.
    Identity Pulumi.AzureNative.DBforPostgreSQL.Outputs.UserAssignedIdentityResponse
    Describes the identity of the application.
    MaintenanceWindow Pulumi.AzureNative.DBforPostgreSQL.Outputs.MaintenanceWindowResponse
    Maintenance window properties of a server.
    Network Pulumi.AzureNative.DBforPostgreSQL.Outputs.NetworkResponse
    Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server.
    Replica Pulumi.AzureNative.DBforPostgreSQL.Outputs.ReplicaResponse
    Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server.
    ReplicationRole string
    Replication role of the server
    Sku Pulumi.AzureNative.DBforPostgreSQL.Outputs.SkuResponse
    The SKU (pricing tier) of the server.
    SourceServerResourceId string
    The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server
    Storage Pulumi.AzureNative.DBforPostgreSQL.Outputs.StorageResponse
    Storage properties of a server.
    Tags Dictionary<string, string>
    Resource tags.
    Version string
    PostgreSQL Server version.
    AzureApiVersion string
    The Azure API version of the resource.
    FullyQualifiedDomainName string
    The fully qualified domain name of a server.
    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
    MinorVersion string
    The minor version of the server.
    Name string
    The name of the resource
    PrivateEndpointConnections []PrivateEndpointConnectionResponse
    List of private endpoint connections associated with the specified resource.
    ReplicaCapacity int
    Replicas allowed for a server.
    State string
    A state of a 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"
    AdministratorLogin string
    The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).
    AuthConfig AuthConfigResponse
    AuthConfig properties of a server.
    AvailabilityZone string
    availability zone information of the server.
    Backup BackupResponse
    Backup properties of a server.
    DataEncryption DataEncryptionResponse
    Data encryption properties of a server.
    HighAvailability HighAvailabilityResponse
    High availability properties of a server.
    Identity UserAssignedIdentityResponse
    Describes the identity of the application.
    MaintenanceWindow MaintenanceWindowResponse
    Maintenance window properties of a server.
    Network NetworkResponse
    Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server.
    Replica ReplicaResponse
    Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server.
    ReplicationRole string
    Replication role of the server
    Sku SkuResponse
    The SKU (pricing tier) of the server.
    SourceServerResourceId string
    The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server
    Storage StorageResponse
    Storage properties of a server.
    Tags map[string]string
    Resource tags.
    Version string
    PostgreSQL Server version.
    azureApiVersion String
    The Azure API version of the resource.
    fullyQualifiedDomainName String
    The fully qualified domain name of a server.
    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
    minorVersion String
    The minor version of the server.
    name String
    The name of the resource
    privateEndpointConnections List<PrivateEndpointConnectionResponse>
    List of private endpoint connections associated with the specified resource.
    replicaCapacity Integer
    Replicas allowed for a server.
    state String
    A state of a 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"
    administratorLogin String
    The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).
    authConfig AuthConfigResponse
    AuthConfig properties of a server.
    availabilityZone String
    availability zone information of the server.
    backup BackupResponse
    Backup properties of a server.
    dataEncryption DataEncryptionResponse
    Data encryption properties of a server.
    highAvailability HighAvailabilityResponse
    High availability properties of a server.
    identity UserAssignedIdentityResponse
    Describes the identity of the application.
    maintenanceWindow MaintenanceWindowResponse
    Maintenance window properties of a server.
    network NetworkResponse
    Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server.
    replica ReplicaResponse
    Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server.
    replicationRole String
    Replication role of the server
    sku SkuResponse
    The SKU (pricing tier) of the server.
    sourceServerResourceId String
    The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server
    storage StorageResponse
    Storage properties of a server.
    tags Map<String,String>
    Resource tags.
    version String
    PostgreSQL Server version.
    azureApiVersion string
    The Azure API version of the resource.
    fullyQualifiedDomainName string
    The fully qualified domain name of a server.
    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
    minorVersion string
    The minor version of the server.
    name string
    The name of the resource
    privateEndpointConnections PrivateEndpointConnectionResponse[]
    List of private endpoint connections associated with the specified resource.
    replicaCapacity number
    Replicas allowed for a server.
    state string
    A state of a 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"
    administratorLogin string
    The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).
    authConfig AuthConfigResponse
    AuthConfig properties of a server.
    availabilityZone string
    availability zone information of the server.
    backup BackupResponse
    Backup properties of a server.
    dataEncryption DataEncryptionResponse
    Data encryption properties of a server.
    highAvailability HighAvailabilityResponse
    High availability properties of a server.
    identity UserAssignedIdentityResponse
    Describes the identity of the application.
    maintenanceWindow MaintenanceWindowResponse
    Maintenance window properties of a server.
    network NetworkResponse
    Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server.
    replica ReplicaResponse
    Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server.
    replicationRole string
    Replication role of the server
    sku SkuResponse
    The SKU (pricing tier) of the server.
    sourceServerResourceId string
    The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server
    storage StorageResponse
    Storage properties of a server.
    tags {[key: string]: string}
    Resource tags.
    version string
    PostgreSQL Server version.
    azure_api_version str
    The Azure API version of the resource.
    fully_qualified_domain_name str
    The fully qualified domain name of a server.
    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
    minor_version str
    The minor version of the server.
    name str
    The name of the resource
    private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]
    List of private endpoint connections associated with the specified resource.
    replica_capacity int
    Replicas allowed for a server.
    state str
    A state of a 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"
    administrator_login str
    The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).
    auth_config AuthConfigResponse
    AuthConfig properties of a server.
    availability_zone str
    availability zone information of the server.
    backup BackupResponse
    Backup properties of a server.
    data_encryption DataEncryptionResponse
    Data encryption properties of a server.
    high_availability HighAvailabilityResponse
    High availability properties of a server.
    identity UserAssignedIdentityResponse
    Describes the identity of the application.
    maintenance_window MaintenanceWindowResponse
    Maintenance window properties of a server.
    network NetworkResponse
    Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server.
    replica ReplicaResponse
    Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server.
    replication_role str
    Replication role of the server
    sku SkuResponse
    The SKU (pricing tier) of the server.
    source_server_resource_id str
    The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server
    storage StorageResponse
    Storage properties of a server.
    tags Mapping[str, str]
    Resource tags.
    version str
    PostgreSQL Server version.
    azureApiVersion String
    The Azure API version of the resource.
    fullyQualifiedDomainName String
    The fully qualified domain name of a server.
    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
    minorVersion String
    The minor version of the server.
    name String
    The name of the resource
    privateEndpointConnections List<Property Map>
    List of private endpoint connections associated with the specified resource.
    replicaCapacity Number
    Replicas allowed for a server.
    state String
    A state of a 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"
    administratorLogin String
    The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).
    authConfig Property Map
    AuthConfig properties of a server.
    availabilityZone String
    availability zone information of the server.
    backup Property Map
    Backup properties of a server.
    dataEncryption Property Map
    Data encryption properties of a server.
    highAvailability Property Map
    High availability properties of a server.
    identity Property Map
    Describes the identity of the application.
    maintenanceWindow Property Map
    Maintenance window properties of a server.
    network Property Map
    Network properties of a server. This Network property is required to be passed only in case you want the server to be Private access server.
    replica Property Map
    Replica properties of a server. These Replica properties are required to be passed only in case you want to Promote a server.
    replicationRole String
    Replication role of the server
    sku Property Map
    The SKU (pricing tier) of the server.
    sourceServerResourceId String
    The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore' or 'GeoRestore' or 'Replica' or 'ReviveDropped'. This property is returned only for Replica server
    storage Property Map
    Storage properties of a server.
    tags Map<String>
    Resource tags.
    version String
    PostgreSQL Server version.

    Supporting Types

    AuthConfigResponse

    ActiveDirectoryAuth string
    If Enabled, Azure Active Directory authentication is enabled.
    PasswordAuth string
    If Enabled, Password authentication is enabled.
    TenantId string
    Tenant id of the server.
    ActiveDirectoryAuth string
    If Enabled, Azure Active Directory authentication is enabled.
    PasswordAuth string
    If Enabled, Password authentication is enabled.
    TenantId string
    Tenant id of the server.
    activeDirectoryAuth String
    If Enabled, Azure Active Directory authentication is enabled.
    passwordAuth String
    If Enabled, Password authentication is enabled.
    tenantId String
    Tenant id of the server.
    activeDirectoryAuth string
    If Enabled, Azure Active Directory authentication is enabled.
    passwordAuth string
    If Enabled, Password authentication is enabled.
    tenantId string
    Tenant id of the server.
    active_directory_auth str
    If Enabled, Azure Active Directory authentication is enabled.
    password_auth str
    If Enabled, Password authentication is enabled.
    tenant_id str
    Tenant id of the server.
    activeDirectoryAuth String
    If Enabled, Azure Active Directory authentication is enabled.
    passwordAuth String
    If Enabled, Password authentication is enabled.
    tenantId String
    Tenant id of the server.

    BackupResponse

    EarliestRestoreDate string
    The earliest restore point time (ISO8601 format) for server.
    BackupRetentionDays int
    Backup retention days for the server.
    GeoRedundantBackup string
    A value indicating whether Geo-Redundant backup is enabled on the server.
    EarliestRestoreDate string
    The earliest restore point time (ISO8601 format) for server.
    BackupRetentionDays int
    Backup retention days for the server.
    GeoRedundantBackup string
    A value indicating whether Geo-Redundant backup is enabled on the server.
    earliestRestoreDate String
    The earliest restore point time (ISO8601 format) for server.
    backupRetentionDays Integer
    Backup retention days for the server.
    geoRedundantBackup String
    A value indicating whether Geo-Redundant backup is enabled on the server.
    earliestRestoreDate string
    The earliest restore point time (ISO8601 format) for server.
    backupRetentionDays number
    Backup retention days for the server.
    geoRedundantBackup string
    A value indicating whether Geo-Redundant backup is enabled on the server.
    earliest_restore_date str
    The earliest restore point time (ISO8601 format) for server.
    backup_retention_days int
    Backup retention days for the server.
    geo_redundant_backup str
    A value indicating whether Geo-Redundant backup is enabled on the server.
    earliestRestoreDate String
    The earliest restore point time (ISO8601 format) for server.
    backupRetentionDays Number
    Backup retention days for the server.
    geoRedundantBackup String
    A value indicating whether Geo-Redundant backup is enabled on the server.

    DataEncryptionResponse

    GeoBackupEncryptionKeyStatus string
    Geo-backup encryption key status for Data encryption enabled server.
    GeoBackupKeyURI string
    URI for the key in keyvault for data encryption for geo-backup of server.
    GeoBackupUserAssignedIdentityId string
    Resource Id for the User assigned identity to be used for data encryption for geo-backup of server.
    PrimaryEncryptionKeyStatus string
    Primary encryption key status for Data encryption enabled server.
    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
    Data encryption type to depict if it is System Managed vs Azure Key vault.
    GeoBackupEncryptionKeyStatus string
    Geo-backup encryption key status for Data encryption enabled server.
    GeoBackupKeyURI string
    URI for the key in keyvault for data encryption for geo-backup of server.
    GeoBackupUserAssignedIdentityId string
    Resource Id for the User assigned identity to be used for data encryption for geo-backup of server.
    PrimaryEncryptionKeyStatus string
    Primary encryption key status for Data encryption enabled server.
    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
    Data encryption type to depict if it is System Managed vs Azure Key vault.
    geoBackupEncryptionKeyStatus String
    Geo-backup encryption key status for Data encryption enabled server.
    geoBackupKeyURI String
    URI for the key in keyvault for data encryption for geo-backup of server.
    geoBackupUserAssignedIdentityId String
    Resource Id for the User assigned identity to be used for data encryption for geo-backup of server.
    primaryEncryptionKeyStatus String
    Primary encryption key status for Data encryption enabled server.
    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
    Data encryption type to depict if it is System Managed vs Azure Key vault.
    geoBackupEncryptionKeyStatus string
    Geo-backup encryption key status for Data encryption enabled server.
    geoBackupKeyURI string
    URI for the key in keyvault for data encryption for geo-backup of server.
    geoBackupUserAssignedIdentityId string
    Resource Id for the User assigned identity to be used for data encryption for geo-backup of server.
    primaryEncryptionKeyStatus string
    Primary encryption key status for Data encryption enabled server.
    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
    Data encryption type to depict if it is System Managed vs Azure Key vault.
    geo_backup_encryption_key_status str
    Geo-backup encryption key status for Data encryption enabled server.
    geo_backup_key_uri str
    URI for the key in keyvault for data encryption for geo-backup of server.
    geo_backup_user_assigned_identity_id str
    Resource Id for the User assigned identity to be used for data encryption for geo-backup of server.
    primary_encryption_key_status str
    Primary encryption key status for Data encryption enabled server.
    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
    Data encryption type to depict if it is System Managed vs Azure Key vault.
    geoBackupEncryptionKeyStatus String
    Geo-backup encryption key status for Data encryption enabled server.
    geoBackupKeyURI String
    URI for the key in keyvault for data encryption for geo-backup of server.
    geoBackupUserAssignedIdentityId String
    Resource Id for the User assigned identity to be used for data encryption for geo-backup of server.
    primaryEncryptionKeyStatus String
    Primary encryption key status for Data encryption enabled server.
    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
    Data encryption type to depict if it is System Managed vs Azure Key vault.

    HighAvailabilityResponse

    State string
    A state of a HA server that is visible to user.
    Mode string
    The HA mode for the server.
    StandbyAvailabilityZone string
    availability zone information of the standby.
    State string
    A state of a HA server that is visible to user.
    Mode string
    The HA mode for the server.
    StandbyAvailabilityZone string
    availability zone information of the standby.
    state String
    A state of a HA server that is visible to user.
    mode String
    The HA mode for the server.
    standbyAvailabilityZone String
    availability zone information of the standby.
    state string
    A state of a HA server that is visible to user.
    mode string
    The HA mode for the server.
    standbyAvailabilityZone string
    availability zone information of the standby.
    state str
    A state of a HA server that is visible to user.
    mode str
    The HA mode for the server.
    standby_availability_zone str
    availability zone information of the standby.
    state String
    A state of a HA server that is visible to user.
    mode String
    The HA mode for the server.
    standbyAvailabilityZone String
    availability zone information of the standby.

    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

    NetworkResponse

    DelegatedSubnetResourceId string
    Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone.
    PrivateDnsZoneArmResourceId string
    Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone.
    PublicNetworkAccess string
    public network access is enabled or not
    DelegatedSubnetResourceId string
    Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone.
    PrivateDnsZoneArmResourceId string
    Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone.
    PublicNetworkAccess string
    public network access is enabled or not
    delegatedSubnetResourceId String
    Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone.
    privateDnsZoneArmResourceId String
    Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone.
    publicNetworkAccess String
    public network access is enabled or not
    delegatedSubnetResourceId string
    Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone.
    privateDnsZoneArmResourceId string
    Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone.
    publicNetworkAccess string
    public network access is enabled or not
    delegated_subnet_resource_id str
    Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone.
    private_dns_zone_arm_resource_id str
    Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone.
    public_network_access str
    public network access is enabled or not
    delegatedSubnetResourceId String
    Delegated subnet arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone.
    privateDnsZoneArmResourceId String
    Private dns zone arm resource id. This is required to be passed during create, in case we want the server to be VNET injected, i.e. Private access server. During update, pass this only if we want to update the value for Private DNS zone.
    publicNetworkAccess String
    public network access is enabled or not

    PrivateEndpointConnectionResponse

    GroupIds List<string>
    The group ids for the private endpoint resource.
    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
    PrivateLinkServiceConnectionState Pulumi.AzureNative.DBforPostgreSQL.Inputs.PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    ProvisioningState string
    The provisioning state of the private endpoint connection 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"
    PrivateEndpoint Pulumi.AzureNative.DBforPostgreSQL.Inputs.PrivateEndpointResponse
    The private endpoint resource.
    GroupIds []string
    The group ids for the private endpoint resource.
    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
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    ProvisioningState string
    The provisioning state of the private endpoint connection 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"
    PrivateEndpoint PrivateEndpointResponse
    The private endpoint resource.
    groupIds List<String>
    The group ids for the private endpoint resource.
    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
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    provisioningState String
    The provisioning state of the private endpoint connection 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"
    privateEndpoint PrivateEndpointResponse
    The private endpoint resource.
    groupIds string[]
    The group ids for the private endpoint resource.
    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
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    provisioningState string
    The provisioning state of the private endpoint connection 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"
    privateEndpoint PrivateEndpointResponse
    The private endpoint resource.
    group_ids Sequence[str]
    The group ids for the private endpoint resource.
    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
    private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
    A collection of information about the state of the connection between service consumer and provider.
    provisioning_state str
    The provisioning state of the private endpoint connection 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"
    private_endpoint PrivateEndpointResponse
    The private endpoint resource.
    groupIds List<String>
    The group ids for the private endpoint resource.
    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
    privateLinkServiceConnectionState Property Map
    A collection of information about the state of the connection between service consumer and provider.
    provisioningState String
    The provisioning state of the private endpoint connection 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"
    privateEndpoint Property Map
    The private endpoint resource.

    PrivateEndpointResponse

    Id string
    The ARM identifier for private endpoint.
    Id string
    The ARM identifier for private endpoint.
    id String
    The ARM identifier for private endpoint.
    id string
    The ARM identifier for private endpoint.
    id str
    The ARM identifier for private endpoint.
    id String
    The ARM identifier for 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.

    ReplicaResponse

    Capacity int
    Replicas allowed for a server.
    ReplicationState string
    Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring
    Role string
    Used to indicate role of the server in replication set.
    Capacity int
    Replicas allowed for a server.
    ReplicationState string
    Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring
    Role string
    Used to indicate role of the server in replication set.
    capacity Integer
    Replicas allowed for a server.
    replicationState String
    Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring
    role String
    Used to indicate role of the server in replication set.
    capacity number
    Replicas allowed for a server.
    replicationState string
    Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring
    role string
    Used to indicate role of the server in replication set.
    capacity int
    Replicas allowed for a server.
    replication_state str
    Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring
    role str
    Used to indicate role of the server in replication set.
    capacity Number
    Replicas allowed for a server.
    replicationState String
    Gets the replication state of a replica server. This property is returned only for replicas api call. Supported values are Active, Catchup, Provisioning, Updating, Broken, Reconfiguring
    role String
    Used to indicate role of the server in replication set.

    SkuResponse

    Name string
    The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3.
    Tier string
    The tier of the particular SKU, e.g. Burstable.
    Name string
    The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3.
    Tier string
    The tier of the particular SKU, e.g. Burstable.
    name String
    The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3.
    tier String
    The tier of the particular SKU, e.g. Burstable.
    name string
    The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3.
    tier string
    The tier of the particular SKU, e.g. Burstable.
    name str
    The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3.
    tier str
    The tier of the particular SKU, e.g. Burstable.
    name String
    The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3.
    tier String
    The tier of the particular SKU, e.g. Burstable.

    StorageResponse

    AutoGrow string
    Flag to enable / disable Storage Auto grow for flexible server.
    Iops int
    Storage tier IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS
    StorageSizeGB int
    Max storage allowed for a server.
    Throughput int
    Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS
    Tier string
    Name of storage tier for IOPS.
    Type string
    Storage type for the server. Allowed values are Premium_LRS and PremiumV2_LRS, and default is Premium_LRS if not specified
    AutoGrow string
    Flag to enable / disable Storage Auto grow for flexible server.
    Iops int
    Storage tier IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS
    StorageSizeGB int
    Max storage allowed for a server.
    Throughput int
    Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS
    Tier string
    Name of storage tier for IOPS.
    Type string
    Storage type for the server. Allowed values are Premium_LRS and PremiumV2_LRS, and default is Premium_LRS if not specified
    autoGrow String
    Flag to enable / disable Storage Auto grow for flexible server.
    iops Integer
    Storage tier IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS
    storageSizeGB Integer
    Max storage allowed for a server.
    throughput Integer
    Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS
    tier String
    Name of storage tier for IOPS.
    type String
    Storage type for the server. Allowed values are Premium_LRS and PremiumV2_LRS, and default is Premium_LRS if not specified
    autoGrow string
    Flag to enable / disable Storage Auto grow for flexible server.
    iops number
    Storage tier IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS
    storageSizeGB number
    Max storage allowed for a server.
    throughput number
    Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS
    tier string
    Name of storage tier for IOPS.
    type string
    Storage type for the server. Allowed values are Premium_LRS and PremiumV2_LRS, and default is Premium_LRS if not specified
    auto_grow str
    Flag to enable / disable Storage Auto grow for flexible server.
    iops int
    Storage tier IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS
    storage_size_gb int
    Max storage allowed for a server.
    throughput int
    Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS
    tier str
    Name of storage tier for IOPS.
    type str
    Storage type for the server. Allowed values are Premium_LRS and PremiumV2_LRS, and default is Premium_LRS if not specified
    autoGrow String
    Flag to enable / disable Storage Auto grow for flexible server.
    iops Number
    Storage tier IOPS quantity. This property is required to be set for storage Type PremiumV2_LRS
    storageSizeGB Number
    Max storage allowed for a server.
    throughput Number
    Storage throughput for the server. This is required to be set for storage Type PremiumV2_LRS
    tier String
    Name of storage tier for IOPS.
    type String
    Storage type for the server. Allowed values are Premium_LRS and PremiumV2_LRS, and default is Premium_LRS if not specified

    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