azure-native.dbforpostgresql.getServer

Represents a server. API Version: 2017-12-01.

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)
// Output-based functions aren't available in Java yet
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:

ByokEnforcement string

Status showing whether the server data encryption is enabled with customer-managed keys.

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

PrivateEndpointConnections List<Pulumi.AzureNative.DBforPostgreSQL.Outputs.ServerPrivateEndpointConnectionResponse>

List of private endpoint connections on a server

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).

EarliestRestoreDate string

Earliest restore point creation time (ISO8601 format)

FullyQualifiedDomainName string

The fully qualified domain name of a server.

Identity Pulumi.AzureNative.DBforPostgreSQL.Outputs.ResourceIdentityResponse

The Azure Active Directory identity of the server.

InfrastructureEncryption string

Status showing whether the server enabled infrastructure encryption.

MasterServerId string

The master server id of a replica server.

MinimalTlsVersion string

Enforce a minimal Tls version for the server.

PublicNetworkAccess string

Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'

ReplicaCapacity int

The maximum number of replicas that a master server can have.

ReplicationRole string

The replication role of the server.

Sku Pulumi.AzureNative.DBforPostgreSQL.Outputs.SkuResponse

The SKU (pricing tier) of the server.

SslEnforcement string

Enable ssl enforcement or not when connect to server.

StorageProfile Pulumi.AzureNative.DBforPostgreSQL.Outputs.StorageProfileResponse

Storage profile of a server.

Tags Dictionary<string, string>

Resource tags.

UserVisibleState string

A state of a server that is visible to user.

Version string

Server version.

ByokEnforcement string

Status showing whether the server data encryption is enabled with customer-managed keys.

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

PrivateEndpointConnections []ServerPrivateEndpointConnectionResponse

List of private endpoint connections on a server

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).

EarliestRestoreDate string

Earliest restore point creation time (ISO8601 format)

FullyQualifiedDomainName string

The fully qualified domain name of a server.

Identity ResourceIdentityResponse

The Azure Active Directory identity of the server.

InfrastructureEncryption string

Status showing whether the server enabled infrastructure encryption.

MasterServerId string

The master server id of a replica server.

MinimalTlsVersion string

Enforce a minimal Tls version for the server.

PublicNetworkAccess string

Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'

ReplicaCapacity int

The maximum number of replicas that a master server can have.

ReplicationRole string

The replication role of the server.

Sku SkuResponse

The SKU (pricing tier) of the server.

SslEnforcement string

Enable ssl enforcement or not when connect to server.

StorageProfile StorageProfileResponse

Storage profile of a server.

Tags map[string]string

Resource tags.

UserVisibleState string

A state of a server that is visible to user.

Version string

Server version.

byokEnforcement String

Status showing whether the server data encryption is enabled with customer-managed keys.

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

privateEndpointConnections List<ServerPrivateEndpointConnectionResponse>

List of private endpoint connections on a server

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).

earliestRestoreDate String

Earliest restore point creation time (ISO8601 format)

fullyQualifiedDomainName String

The fully qualified domain name of a server.

identity ResourceIdentityResponse

The Azure Active Directory identity of the server.

infrastructureEncryption String

Status showing whether the server enabled infrastructure encryption.

masterServerId String

The master server id of a replica server.

minimalTlsVersion String

Enforce a minimal Tls version for the server.

publicNetworkAccess String

Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'

replicaCapacity Integer

The maximum number of replicas that a master server can have.

replicationRole String

The replication role of the server.

sku SkuResponse

The SKU (pricing tier) of the server.

sslEnforcement String

Enable ssl enforcement or not when connect to server.

storageProfile StorageProfileResponse

Storage profile of a server.

tags Map<String,String>

Resource tags.

userVisibleState String

A state of a server that is visible to user.

version String

Server version.

byokEnforcement string

Status showing whether the server data encryption is enabled with customer-managed keys.

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

privateEndpointConnections ServerPrivateEndpointConnectionResponse[]

List of private endpoint connections on a server

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).

earliestRestoreDate string

Earliest restore point creation time (ISO8601 format)

fullyQualifiedDomainName string

The fully qualified domain name of a server.

identity ResourceIdentityResponse

The Azure Active Directory identity of the server.

infrastructureEncryption string

Status showing whether the server enabled infrastructure encryption.

masterServerId string

The master server id of a replica server.

minimalTlsVersion string

Enforce a minimal Tls version for the server.

publicNetworkAccess string

Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'

replicaCapacity number

The maximum number of replicas that a master server can have.

replicationRole string

The replication role of the server.

sku SkuResponse

The SKU (pricing tier) of the server.

sslEnforcement string

Enable ssl enforcement or not when connect to server.

storageProfile StorageProfileResponse

Storage profile of a server.

tags {[key: string]: string}

Resource tags.

userVisibleState string

A state of a server that is visible to user.

version string

Server version.

byok_enforcement str

Status showing whether the server data encryption is enabled with customer-managed keys.

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

private_endpoint_connections Sequence[ServerPrivateEndpointConnectionResponse]

List of private endpoint connections on a server

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).

earliest_restore_date str

Earliest restore point creation time (ISO8601 format)

fully_qualified_domain_name str

The fully qualified domain name of a server.

identity ResourceIdentityResponse

The Azure Active Directory identity of the server.

infrastructure_encryption str

Status showing whether the server enabled infrastructure encryption.

master_server_id str

The master server id of a replica server.

minimal_tls_version str

Enforce a minimal Tls version for the server.

public_network_access str

Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'

replica_capacity int

The maximum number of replicas that a master server can have.

replication_role str

The replication role of the server.

sku SkuResponse

The SKU (pricing tier) of the server.

ssl_enforcement str

Enable ssl enforcement or not when connect to server.

storage_profile StorageProfileResponse

Storage profile of a server.

tags Mapping[str, str]

Resource tags.

user_visible_state str

A state of a server that is visible to user.

version str

Server version.

byokEnforcement String

Status showing whether the server data encryption is enabled with customer-managed keys.

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

privateEndpointConnections List<Property Map>

List of private endpoint connections on a server

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).

earliestRestoreDate String

Earliest restore point creation time (ISO8601 format)

fullyQualifiedDomainName String

The fully qualified domain name of a server.

identity Property Map

The Azure Active Directory identity of the server.

infrastructureEncryption String

Status showing whether the server enabled infrastructure encryption.

masterServerId String

The master server id of a replica server.

minimalTlsVersion String

Enforce a minimal Tls version for the server.

publicNetworkAccess String

Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'

replicaCapacity Number

The maximum number of replicas that a master server can have.

replicationRole String

The replication role of the server.

sku Property Map

The SKU (pricing tier) of the server.

sslEnforcement String

Enable ssl enforcement or not when connect to server.

storageProfile Property Map

Storage profile of a server.

tags Map<String>

Resource tags.

userVisibleState String

A state of a server that is visible to user.

version String

Server version.

Supporting Types

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.

ResourceIdentityResponse

PrincipalId string

The Azure Active Directory principal id.

TenantId string

The Azure Active Directory tenant id.

Type string

The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.

PrincipalId string

The Azure Active Directory principal id.

TenantId string

The Azure Active Directory tenant id.

Type string

The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.

principalId String

The Azure Active Directory principal id.

tenantId String

The Azure Active Directory tenant id.

type String

The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.

principalId string

The Azure Active Directory principal id.

tenantId string

The Azure Active Directory tenant id.

type string

The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.

principal_id str

The Azure Active Directory principal id.

tenant_id str

The Azure Active Directory tenant id.

type str

The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.

principalId String

The Azure Active Directory principal id.

tenantId String

The Azure Active Directory tenant id.

type String

The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.

ServerPrivateEndpointConnectionPropertiesResponse

ProvisioningState string

State of the private endpoint connection.

PrivateEndpoint PrivateEndpointPropertyResponse

Private endpoint which the connection belongs to.

PrivateLinkServiceConnectionState ServerPrivateLinkServiceConnectionStatePropertyResponse

Connection state of the private endpoint connection.

provisioningState String

State of the private endpoint connection.

privateEndpoint PrivateEndpointPropertyResponse

Private endpoint which the connection belongs to.

privateLinkServiceConnectionState ServerPrivateLinkServiceConnectionStatePropertyResponse

Connection state of the private endpoint connection.

provisioningState string

State of the private endpoint connection.

privateEndpoint PrivateEndpointPropertyResponse

Private endpoint which the connection belongs to.

privateLinkServiceConnectionState ServerPrivateLinkServiceConnectionStatePropertyResponse

Connection state of the private endpoint connection.

provisioning_state str

State of the private endpoint connection.

private_endpoint PrivateEndpointPropertyResponse

Private endpoint which the connection belongs to.

private_link_service_connection_state ServerPrivateLinkServiceConnectionStatePropertyResponse

Connection state of the private endpoint connection.

provisioningState String

State of the private endpoint connection.

privateEndpoint Property Map

Private endpoint which the connection belongs to.

privateLinkServiceConnectionState Property Map

Connection state of the private endpoint connection.

ServerPrivateEndpointConnectionResponse

Id string

Resource ID of the Private Endpoint Connection.

Properties Pulumi.AzureNative.DBforPostgreSQL.Inputs.ServerPrivateEndpointConnectionPropertiesResponse

Private endpoint connection properties

Id string

Resource ID of the Private Endpoint Connection.

Properties ServerPrivateEndpointConnectionPropertiesResponse

Private endpoint connection properties

id String

Resource ID of the Private Endpoint Connection.

properties ServerPrivateEndpointConnectionPropertiesResponse

Private endpoint connection properties

id string

Resource ID of the Private Endpoint Connection.

properties ServerPrivateEndpointConnectionPropertiesResponse

Private endpoint connection properties

id str

Resource ID of the Private Endpoint Connection.

properties ServerPrivateEndpointConnectionPropertiesResponse

Private endpoint connection properties

id String

Resource ID of the Private Endpoint Connection.

properties Property Map

Private endpoint connection properties

ServerPrivateLinkServiceConnectionStatePropertyResponse

ActionsRequired string

The actions required for private link service connection.

Description string

The private link service connection description.

Status string

The private link service connection status.

ActionsRequired string

The actions required for private link service connection.

Description string

The private link service connection description.

Status string

The private link service connection status.

actionsRequired String

The actions required for private link service connection.

description String

The private link service connection description.

status String

The private link service connection status.

actionsRequired string

The actions required for private link service connection.

description string

The private link service connection description.

status string

The private link service connection status.

actions_required str

The actions required for private link service connection.

description str

The private link service connection description.

status str

The private link service connection status.

actionsRequired String

The actions required for private link service connection.

description String

The private link service connection description.

status String

The private link service connection status.

SkuResponse

Name string

The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8.

Capacity int

The scale up/out capacity, representing server's compute units.

Family string

The family of hardware.

Size string

The size code, to be interpreted by resource as appropriate.

Tier string

The tier of the particular SKU, e.g. Basic.

Name string

The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8.

Capacity int

The scale up/out capacity, representing server's compute units.

Family string

The family of hardware.

Size string

The size code, to be interpreted by resource as appropriate.

Tier string

The tier of the particular SKU, e.g. Basic.

name String

The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8.

capacity Integer

The scale up/out capacity, representing server's compute units.

family String

The family of hardware.

size String

The size code, to be interpreted by resource as appropriate.

tier String

The tier of the particular SKU, e.g. Basic.

name string

The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8.

capacity number

The scale up/out capacity, representing server's compute units.

family string

The family of hardware.

size string

The size code, to be interpreted by resource as appropriate.

tier string

The tier of the particular SKU, e.g. Basic.

name str

The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8.

capacity int

The scale up/out capacity, representing server's compute units.

family str

The family of hardware.

size str

The size code, to be interpreted by resource as appropriate.

tier str

The tier of the particular SKU, e.g. Basic.

name String

The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8.

capacity Number

The scale up/out capacity, representing server's compute units.

family String

The family of hardware.

size String

The size code, to be interpreted by resource as appropriate.

tier String

The tier of the particular SKU, e.g. Basic.

StorageProfileResponse

BackupRetentionDays int

Backup retention days for the server.

GeoRedundantBackup string

Enable Geo-redundant or not for server backup.

StorageAutogrow string

Enable Storage Auto Grow.

StorageMB int

Max storage allowed for a server.

BackupRetentionDays int

Backup retention days for the server.

GeoRedundantBackup string

Enable Geo-redundant or not for server backup.

StorageAutogrow string

Enable Storage Auto Grow.

StorageMB int

Max storage allowed for a server.

backupRetentionDays Integer

Backup retention days for the server.

geoRedundantBackup String

Enable Geo-redundant or not for server backup.

storageAutogrow String

Enable Storage Auto Grow.

storageMB Integer

Max storage allowed for a server.

backupRetentionDays number

Backup retention days for the server.

geoRedundantBackup string

Enable Geo-redundant or not for server backup.

storageAutogrow string

Enable Storage Auto Grow.

storageMB number

Max storage allowed for a server.

backup_retention_days int

Backup retention days for the server.

geo_redundant_backup str

Enable Geo-redundant or not for server backup.

storage_autogrow str

Enable Storage Auto Grow.

storage_mb int

Max storage allowed for a server.

backupRetentionDays Number

Backup retention days for the server.

geoRedundantBackup String

Enable Geo-redundant or not for server backup.

storageAutogrow String

Enable Storage Auto Grow.

storageMB Number

Max storage allowed for a server.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0