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

azure-native-v2.dbformariadb.getServer

Explore with Pulumi AI

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

Gets information about a server. Azure REST API version: 2018-06-01.

Other available API versions: 2018-06-01-preview.

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>
Copy
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]
Copy
func LookupServer(ctx *Context, args *LookupServerArgs, opts ...InvokeOption) (*LookupServerResult, error)
func LookupServerOutput(ctx *Context, args *LookupServerOutputArgs, opts ...InvokeOption) LookupServerResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetServerResult> getServer(GetServerArgs args, InvokeOptions options)
public static Output<GetServerResult> getServer(GetServerArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:dbformariadb:getServer
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serverName
This property is required.
Changes to this property will trigger replacement.
string
The name of the server.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
server_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the server.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serverName
This property is required.
Changes to this property will trigger replacement.
String
The name of the server.

getServer Result

The following output properties are available:

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.DBforMariaDB.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.
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.DBforMariaDB.Outputs.SkuResponse
The SKU (pricing tier) of the server.
SslEnforcement string
Enable ssl enforcement or not when connect to server.
StorageProfile Pulumi.AzureNative.DBforMariaDB.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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.

ServerPrivateEndpointConnectionPropertiesResponse

ProvisioningState This property is required. string
State of the private endpoint connection.
PrivateEndpoint Pulumi.AzureNative.DBforMariaDB.Inputs.PrivateEndpointPropertyResponse
Private endpoint which the connection belongs to.
PrivateLinkServiceConnectionState Pulumi.AzureNative.DBforMariaDB.Inputs.ServerPrivateLinkServiceConnectionStatePropertyResponse
Connection state of the private endpoint connection.
ProvisioningState This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string
Resource Id of the private endpoint connection.
Properties This property is required. Pulumi.AzureNative.DBforMariaDB.Inputs.ServerPrivateEndpointConnectionPropertiesResponse
Private endpoint connection properties
Id This property is required. string
Resource Id of the private endpoint connection.
Properties This property is required. ServerPrivateEndpointConnectionPropertiesResponse
Private endpoint connection properties
id This property is required. String
Resource Id of the private endpoint connection.
properties This property is required. ServerPrivateEndpointConnectionPropertiesResponse
Private endpoint connection properties
id This property is required. string
Resource Id of the private endpoint connection.
properties This property is required. ServerPrivateEndpointConnectionPropertiesResponse
Private endpoint connection properties
id This property is required. str
Resource Id of the private endpoint connection.
properties This property is required. ServerPrivateEndpointConnectionPropertiesResponse
Private endpoint connection properties
id This property is required. String
Resource Id of the private endpoint connection.
properties This property is required. Property Map
Private endpoint connection properties

ServerPrivateLinkServiceConnectionStatePropertyResponse

ActionsRequired This property is required. string
The actions required for private link service connection.
Description This property is required. string
The private link service connection description.
Status This property is required. string
The private link service connection status.
ActionsRequired This property is required. string
The actions required for private link service connection.
Description This property is required. string
The private link service connection description.
Status This property is required. string
The private link service connection status.
actionsRequired This property is required. String
The actions required for private link service connection.
description This property is required. String
The private link service connection description.
status This property is required. String
The private link service connection status.
actionsRequired This property is required. string
The actions required for private link service connection.
description This property is required. string
The private link service connection description.
status This property is required. string
The private link service connection status.
actions_required This property is required. str
The actions required for private link service connection.
description This property is required. str
The private link service connection description.
status This property is required. str
The private link service connection status.
actionsRequired This property is required. String
The actions required for private link service connection.
description This property is required. String
The private link service connection description.
status This property is required. String
The private link service connection status.

SkuResponse

Name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi