Servers - Get

Gets information about a server.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}?api-version=2018-06-01-preview

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The subscription ID that identifies an Azure subscription.

resourceGroupName
path True
  • string

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

serverName
path True
  • string

The name of the server.

api-version
query True
  • string

The API version to use for the request.

Responses

Name Type Description
200 OK

OK

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ServerGet

Sample Request

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMariaDB/servers/mariadbtestsvc4?api-version=2018-06-01-preview

Sample Response

{
  "sku": {
    "name": "GP_Gen5_2",
    "tier": "GeneralPurpose",
    "family": "Gen5",
    "capacity": 2
  },
  "properties": {
    "administratorLogin": "cloudsa",
    "storageProfile": {
      "storageMB": 128000,
      "backupRetentionDays": 7,
      "geoRedundantBackup": "Enabled"
    },
    "version": "5.7",
    "sslEnforcement": "Enabled",
    "userVisibleState": "Ready",
    "fullyQualifiedDomainName": "mariadbtestsvc4.mariadb.database.azure.com",
    "earliestRestoreDate": "2018-03-14T18:02:41.577+00:00",
    "replicationRole": "None",
    "masterServerId": "",
    "replicaCapacity": 5
  },
  "location": "westus",
  "tags": {
    "ElasticServer": "1"
  },
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMariaDB/servers/mariadbtestsvc4",
  "name": "mariadbtestsvc4",
  "type": "Microsoft.DBforMariaDB/servers"
}

Definitions

GeoRedundantBackup

Enable Geo-redundant or not for server backup.

IdentityType

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

ResourceIdentity

Azure Active Directory identity configuration for a resource.

Server

Represents a server.

ServerState

A state of a server that is visible to user.

ServerVersion

The version of a server.

Sku

Billing information related properties of a server.

SkuTier

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

SslEnforcementEnum

Enable ssl enforcement or not when connect to server.

StorageAutogrow

Enable Storage Auto Grow.

StorageProfile

Storage Profile properties of a server

GeoRedundantBackup

Enable Geo-redundant or not for server backup.

Name Type Description
Disabled
  • string
Enabled
  • string

IdentityType

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

Name Type Description
SystemAssigned
  • string

ResourceIdentity

Azure Active Directory identity configuration for a resource.

Name Type Description
principalId
  • string

The Azure Active Directory principal id.

tenantId
  • string

The Azure Active Directory tenant id.

type

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

Server

Represents a server.

Name Type Description
id
  • string

Resource ID

identity

The Azure Active Directory identity of the server.

location
  • string

The location the resource resides in.

name
  • string

Resource name.

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

properties.earliestRestoreDate
  • string

Earliest restore point creation time (ISO8601 format)

properties.fullyQualifiedDomainName
  • string

The fully qualified domain name of a server.

properties.masterServerId
  • string

The master server id of a replica server.

properties.replicaCapacity
  • integer

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

properties.replicationRole
  • string

The replication role of the server.

properties.sslEnforcement

Enable ssl enforcement or not when connect to server.

properties.storageProfile

Storage profile of a server.

properties.userVisibleState

A state of a server that is visible to user.

properties.version

Server version.

sku

The SKU (pricing tier) of the server.

tags
  • object

Application-specific metadata in the form of key-value pairs.

type
  • string

Resource type.

ServerState

A state of a server that is visible to user.

Name Type Description
Disabled
  • string
Dropping
  • string
Ready
  • string

ServerVersion

The version of a server.

Name Type Description
5.6
  • string
5.7
  • string

Sku

Billing information related properties of a server.

Name Type Description
capacity
  • integer

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

family
  • string

The family of hardware.

name
  • string

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

size
  • string

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

tier

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

SkuTier

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

Name Type Description
Basic
  • string
GeneralPurpose
  • string
MemoryOptimized
  • string

SslEnforcementEnum

Enable ssl enforcement or not when connect to server.

Name Type Description
Disabled
  • string
Enabled
  • string

StorageAutogrow

Enable Storage Auto Grow.

Name Type Description
Disabled
  • string
Enabled
  • string

StorageProfile

Storage Profile properties of a server

Name Type Description
backupRetentionDays
  • integer

Backup retention days for the server.

geoRedundantBackup

Enable Geo-redundant or not for server backup.

storageAutogrow

Enable Storage Auto Grow.

storageMB
  • integer

Max storage allowed for a server.