Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. azurearcdata
  5. getPostgresInstance
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.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.azurearcdata.getPostgresInstance

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.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

    Retrieves a postgres Instance resource

    Uses Azure REST API version 2024-01-01.

    Other available API versions: 2023-01-15-preview, 2024-05-01-preview, 2025-03-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native azurearcdata [ApiVersion]. See the version guide for details.

    Using getPostgresInstance

    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 getPostgresInstance(args: GetPostgresInstanceArgs, opts?: InvokeOptions): Promise<GetPostgresInstanceResult>
function getPostgresInstanceOutput(args: GetPostgresInstanceOutputArgs, opts?: InvokeOptions): Output<GetPostgresInstanceResult>
    def get_postgres_instance(postgres_instance_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetPostgresInstanceResult
def get_postgres_instance_output(postgres_instance_name: Optional[pulumi.Input[str]] = None,
                          resource_group_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetPostgresInstanceResult]
    func LookupPostgresInstance(ctx *Context, args *LookupPostgresInstanceArgs, opts ...InvokeOption) (*LookupPostgresInstanceResult, error)
func LookupPostgresInstanceOutput(ctx *Context, args *LookupPostgresInstanceOutputArgs, opts ...InvokeOption) LookupPostgresInstanceResultOutput

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

    public static class GetPostgresInstance 
{
    public static Task<GetPostgresInstanceResult> InvokeAsync(GetPostgresInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetPostgresInstanceResult> Invoke(GetPostgresInstanceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPostgresInstanceResult> getPostgresInstance(GetPostgresInstanceArgs args, InvokeOptions options)
public static Output<GetPostgresInstanceResult> getPostgresInstance(GetPostgresInstanceArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:azurearcdata:getPostgresInstance
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PostgresInstanceName string
    Name of Postgres Instance
    ResourceGroupName string
    The name of the Azure resource group
    PostgresInstanceName string
    Name of Postgres Instance
    ResourceGroupName string
    The name of the Azure resource group
    postgresInstanceName String
    Name of Postgres Instance
    resourceGroupName String
    The name of the Azure resource group
    postgresInstanceName string
    Name of Postgres Instance
    resourceGroupName string
    The name of the Azure resource group
    postgres_instance_name str
    Name of Postgres Instance
    resource_group_name str
    The name of the Azure resource group
    postgresInstanceName String
    Name of Postgres Instance
    resourceGroupName String
    The name of the Azure resource group

    getPostgresInstance Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.AzureArcData.Outputs.PostgresInstancePropertiesResponse
    null
    SystemData Pulumi.AzureNative.AzureArcData.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"
    ExtendedLocation Pulumi.AzureNative.AzureArcData.Outputs.ExtendedLocationResponse
    The extendedLocation of the resource.
    Sku Pulumi.AzureNative.AzureArcData.Outputs.PostgresInstanceSkuResponse
    Resource sku.
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties PostgresInstancePropertiesResponse
    null
    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"
    ExtendedLocation ExtendedLocationResponse
    The extendedLocation of the resource.
    Sku PostgresInstanceSkuResponse
    Resource sku.
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties PostgresInstancePropertiesResponse
    null
    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"
    extendedLocation ExtendedLocationResponse
    The extendedLocation of the resource.
    sku PostgresInstanceSkuResponse
    Resource sku.
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    properties PostgresInstancePropertiesResponse
    null
    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"
    extendedLocation ExtendedLocationResponse
    The extendedLocation of the resource.
    sku PostgresInstanceSkuResponse
    Resource sku.
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    properties PostgresInstancePropertiesResponse
    null
    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"
    extended_location ExtendedLocationResponse
    The extendedLocation of the resource.
    sku PostgresInstanceSkuResponse
    Resource sku.
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties Property Map
    null
    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"
    extendedLocation Property Map
    The extendedLocation of the resource.
    sku Property Map
    Resource sku.
    tags Map<String>
    Resource tags.

    Supporting Types

    BasicLoginInformationResponse

    Username string
    Login username.
    Username string
    Login username.
    username String
    Login username.
    username string
    Login username.
    username str
    Login username.
    username String
    Login username.

    ExtendedLocationResponse

    Name string
    The name of the extended location.
    Type string
    The type of the extended location.
    Name string
    The name of the extended location.
    Type string
    The type of the extended location.
    name String
    The name of the extended location.
    type String
    The type of the extended location.
    name string
    The name of the extended location.
    type string
    The type of the extended location.
    name str
    The name of the extended location.
    type str
    The type of the extended location.
    name String
    The name of the extended location.
    type String
    The type of the extended location.

    PostgresInstancePropertiesResponse

    ProvisioningState string
    The provisioning state of the Azure Arc-enabled PostgreSQL instance.
    Admin string
    The instance admin
    BasicLoginInformation Pulumi.AzureNative.AzureArcData.Inputs.BasicLoginInformationResponse
    Username and password for basic authentication.
    DataControllerId string
    The data controller id
    K8sRaw object
    The raw kubernetes information
    LastUploadedDate string
    Last uploaded date from Kubernetes cluster. Defaults to current date time
    ProvisioningState string
    The provisioning state of the Azure Arc-enabled PostgreSQL instance.
    Admin string
    The instance admin
    BasicLoginInformation BasicLoginInformationResponse
    Username and password for basic authentication.
    DataControllerId string
    The data controller id
    K8sRaw interface{}
    The raw kubernetes information
    LastUploadedDate string
    Last uploaded date from Kubernetes cluster. Defaults to current date time
    provisioningState String
    The provisioning state of the Azure Arc-enabled PostgreSQL instance.
    admin String
    The instance admin
    basicLoginInformation BasicLoginInformationResponse
    Username and password for basic authentication.
    dataControllerId String
    The data controller id
    k8sRaw Object
    The raw kubernetes information
    lastUploadedDate String
    Last uploaded date from Kubernetes cluster. Defaults to current date time
    provisioningState string
    The provisioning state of the Azure Arc-enabled PostgreSQL instance.
    admin string
    The instance admin
    basicLoginInformation BasicLoginInformationResponse
    Username and password for basic authentication.
    dataControllerId string
    The data controller id
    k8sRaw any
    The raw kubernetes information
    lastUploadedDate string
    Last uploaded date from Kubernetes cluster. Defaults to current date time
    provisioning_state str
    The provisioning state of the Azure Arc-enabled PostgreSQL instance.
    admin str
    The instance admin
    basic_login_information BasicLoginInformationResponse
    Username and password for basic authentication.
    data_controller_id str
    The data controller id
    k8s_raw Any
    The raw kubernetes information
    last_uploaded_date str
    Last uploaded date from Kubernetes cluster. Defaults to current date time
    provisioningState String
    The provisioning state of the Azure Arc-enabled PostgreSQL instance.
    admin String
    The instance admin
    basicLoginInformation Property Map
    Username and password for basic authentication.
    dataControllerId String
    The data controller id
    k8sRaw Any
    The raw kubernetes information
    lastUploadedDate String
    Last uploaded date from Kubernetes cluster. Defaults to current date time

    PostgresInstanceSkuResponse

    Name string
    The name of the SKU. It is typically a letter+number code
    Capacity int
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    Dev bool
    Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose.
    Family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    Size string
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    Tier string
    This field is required to be implemented by the Resource Provider if the service has more than one tier.
    Name string
    The name of the SKU. It is typically a letter+number code
    Capacity int
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    Dev bool
    Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose.
    Family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    Size string
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    Tier string
    This field is required to be implemented by the Resource Provider if the service has more than one tier.
    name String
    The name of the SKU. It is typically a letter+number code
    capacity Integer
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    dev Boolean
    Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose.
    family String
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size String
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    tier String
    This field is required to be implemented by the Resource Provider if the service has more than one tier.
    name string
    The name of the SKU. It is typically a letter+number code
    capacity number
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    dev boolean
    Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose.
    family string
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size string
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    tier string
    This field is required to be implemented by the Resource Provider if the service has more than one tier.
    name str
    The name of the SKU. It is typically a letter+number code
    capacity int
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    dev bool
    Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose.
    family str
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size str
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    tier str
    This field is required to be implemented by the Resource Provider if the service has more than one tier.
    name String
    The name of the SKU. It is typically a letter+number code
    capacity Number
    If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
    dev Boolean
    Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose.
    family String
    If the service has different generations of hardware, for the same SKU, then that can be captured here.
    size String
    The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
    tier String
    This field is required to be implemented by the Resource Provider if the service has more than one tier.

    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 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.4.0 published on Wednesday, May 7, 2025 by Pulumi
    pulumi/pulumi-azure-native