Servers - List
List all the servers in a given subscription.
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/servers?api-version=2018-06-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
subscription
|
path | True |
string |
The ID of the target subscription. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Error response describing why the operation failed. |
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
ServerList
Sample request
GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/providers/Microsoft.DBforMariaDB/servers?api-version=2018-06-01
Sample response
{
"value": [
{
"sku": {
"name": "B_Gen4_2",
"tier": "Basic",
"family": "Gen4",
"capacity": 2
},
"properties": {
"administratorLogin": "testuser",
"storageProfile": {
"storageMB": 5120,
"backupRetentionDays": 7,
"geoRedundantBackup": "Disabled"
},
"version": "10.3",
"sslEnforcement": "Enabled",
"minimalTlsVersion": "TLS1_2",
"userVisibleState": "Ready",
"fullyQualifiedDomainName": "mariadbtestsvc1.mariadb.database.azure.com",
"earliestRestoreDate": "2018-02-28T23:56:02.627+00:00",
"publicNetworkAccess": "Enabled",
"privateEndpointConnections": []
},
"location": "westus",
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMariaDB/servers/mariadbtestsvc1",
"name": "mariadbtestsvc1",
"type": "Microsoft.DBforMariaDB/servers"
},
{
"sku": {
"name": "GP_Gen4_2",
"tier": "GeneralPurpose",
"family": "Gen4",
"capacity": 2
},
"properties": {
"administratorLogin": "testuser",
"storageProfile": {
"storageMB": 5120,
"backupRetentionDays": 7,
"geoRedundantBackup": "Disabled"
},
"version": "10.3",
"sslEnforcement": "Enabled",
"minimalTlsVersion": "TLS1_1",
"userVisibleState": "Ready",
"fullyQualifiedDomainName": "mariadbtstsvc2.mariadb.database.azure.com",
"earliestRestoreDate": "2018-02-28T23:56:54.3+00:00",
"publicNetworkAccess": "Enabled",
"privateEndpointConnections": [
{
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMariaDB/servers/mariadbtstsvc2/privateEndpointConnections/private-endpoint-name-00000000-1111-2222-3333-444444444444",
"properties": {
"provisioningState": "Ready",
"privateEndpoint": {
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
},
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Auto-approved",
"actionsRequired": "None"
}
}
}
]
},
"location": "westus",
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMariaDB/servers/mariadbtstsvc2",
"name": "mariadbtstsvc2",
"type": "Microsoft.DBforMariaDB/servers"
},
{
"sku": {
"name": "GP_Gen4_4",
"tier": "GeneralPurpose",
"family": "Gen4",
"capacity": 4
},
"properties": {
"administratorLogin": "testuser",
"storageProfile": {
"storageMB": 102400,
"backupRetentionDays": 35,
"geoRedundantBackup": "Enabled"
},
"version": "10.3",
"sslEnforcement": "Enabled",
"minimalTlsVersion": "TLS1_0",
"userVisibleState": "Ready",
"fullyQualifiedDomainName": "mariadbtestsvc3.mariadb.database.azure.com",
"earliestRestoreDate": "2018-02-28T23:59:44.847+00:00",
"publicNetworkAccess": "Enabled",
"privateEndpointConnections": [
{
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg/providers/Microsoft.DBforMariaDB/servers/mariadbtestsvc3/privateEndpointConnections/private-endpoint-name-00000000-1111-2222-3333-444444444444",
"properties": {
"provisioningState": "Ready",
"privateEndpoint": {
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
},
"privateLinkServiceConnectionState": {
"status": "Approved",
"description": "Auto-approved",
"actionsRequired": "None"
}
}
}
]
},
"location": "westus",
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/testrg1/providers/Microsoft.DBforMariaDB/servers/mariadbtestsvc3",
"name": "mariadbtestsvc3",
"type": "Microsoft.DBforMariaDB/servers"
}
]
}
Definitions
Name | Description |
---|---|
Cloud |
An error response from the Batch service. |
Error |
The resource management error additional info. |
Error |
Error Response |
Geo |
Enable Geo-redundant or not for server backup. |
Minimal |
Enforce a minimal Tls version for the server. |
Private |
Private endpoint which the connection belongs to. |
Private |
State of the private endpoint connection. |
Private |
The actions required for private link service connection. |
Private |
The private link service connection status. |
Public |
Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' |
Server |
The list of servers |
Server |
A list of servers. |
Server |
List of private endpoint connections on a server |
Server |
Private endpoint connection properties |
Server |
Connection state of the private endpoint connection. |
Server |
A state of a server that is visible to user. |
Server |
Server version. |
Sku |
The SKU (pricing tier) of the server. |
Sku |
The tier of the particular SKU, e.g. Basic. |
Ssl |
Enable ssl enforcement or not when connect to server. |
Storage |
Enable Storage Auto Grow. |
Storage |
Storage profile of a server. |
CloudError
An error response from the Batch service.
Name | Type | Description |
---|---|---|
error |
Error Response |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorResponse
Error Response
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
GeoRedundantBackup
Enable Geo-redundant or not for server backup.
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
MinimalTlsVersionEnum
Enforce a minimal Tls version for the server.
Name | Type | Description |
---|---|---|
TLS1_0 |
string |
|
TLS1_1 |
string |
|
TLS1_2 |
string |
|
TLSEnforcementDisabled |
string |
PrivateEndpointProperty
Private endpoint which the connection belongs to.
Name | Type | Description |
---|---|---|
id |
string |
Resource id of the private endpoint. |
PrivateEndpointProvisioningState
State of the private endpoint connection.
Name | Type | Description |
---|---|---|
Approving |
string |
|
Dropping |
string |
|
Failed |
string |
|
Ready |
string |
|
Rejecting |
string |
PrivateLinkServiceConnectionStateActionsRequire
The actions required for private link service connection.
Name | Type | Description |
---|---|---|
None |
string |
PrivateLinkServiceConnectionStateStatus
The private link service connection status.
Name | Type | Description |
---|---|---|
Approved |
string |
|
Disconnected |
string |
|
Pending |
string |
|
Rejected |
string |
PublicNetworkAccessEnum
Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Enabled |
string |
Server
The list of servers
Name | Type | Description |
---|---|---|
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.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.minimalTlsVersion |
Enforce a minimal Tls version for the server. |
|
properties.privateEndpointConnections |
List of private endpoint connections on a server |
|
properties.publicNetworkAccess |
Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' |
|
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 |
Resource tags. |
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
ServerListResult
A list of servers.
Name | Type | Description |
---|---|---|
value |
Server[] |
The list of servers |
ServerPrivateEndpointConnection
List of private endpoint connections on a server
Name | Type | Description |
---|---|---|
id |
string |
Resource Id of the private endpoint connection. |
properties |
Private endpoint connection properties |
ServerPrivateEndpointConnectionProperties
Private endpoint connection properties
Name | Type | Description |
---|---|---|
privateEndpoint |
Private endpoint which the connection belongs to. |
|
privateLinkServiceConnectionState |
Connection state of the private endpoint connection. |
|
provisioningState |
State of the private endpoint connection. |
ServerPrivateLinkServiceConnectionStateProperty
Connection state of the private endpoint connection.
Name | Type | Description |
---|---|---|
actionsRequired |
The actions required for private link service connection. |
|
description |
string |
The private link service connection description. |
status |
The private link service connection status. |
ServerState
A state of a server that is visible to user.
Name | Type | Description |
---|---|---|
Disabled |
string |
|
Dropping |
string |
|
Ready |
string |
ServerVersion
Server version.
Name | Type | Description |
---|---|---|
10.2 |
string |
|
10.3 |
string |
Sku
The SKU (pricing tier) of the 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 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. |