How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure Servers API

The Servers API from Microsoft Azure — 19 operation(s) for servers.

Microsoft Azure Servers API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Servers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 25 operations across 19 paths, and defines 52 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

25 operations 19 paths 52 schemas 2 DELETE14 GET2 PATCH5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 25

Across 19 paths, the API surfaces 25 operations — 2 DELETE, 14 GET, 2 PATCH, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Servers 25
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/servers
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Servers
microsoftAzureServersListbycluster 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/servers/{serverName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Servers Servername
microsoftAzureServersGet 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/usages
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Servername Usages
microsoftAzureServerusagesListbyserver 4 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Analysisservices Servers Servername
microsoftAzureServersGetdetails 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Analysisservices Servers Servername
microsoftAzureServersCreate 4 params body → 200201default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Analysisservices Servers Servername
microsoftAzureServersDelete 4 params → 200202204default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Analysisservices Servers Servername
microsoftAzureServersUpdate 4 params body → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/suspend
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Analysisservices Servers Servername Suspend
microsoftAzureServersSuspend 4 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/resume
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Analysisservices Servers Servername Resume
microsoftAzureServersResume 4 params → 200202default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Analysisservices Servers
microsoftAzureServersListbyresourcegroup 3 params → 200default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.AnalysisServices/servers
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Analysisservices Servers
microsoftAzureServersList 2 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/skus
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Analysisservices Servers Servername Skus
microsoftAzureServersListskusforexisting 4 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/listGatewayStatus
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Analysisservices Servers Servername Listgatewaystatus
microsoftAzureServersListgatewaystatus 4 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/dissociateGateway
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Analysisservices Servers Servername Dissociategateway
microsoftAzureServersDissociategateway 4 params → 200default
POST
/subscriptions/{subscriptionId}/providers/Microsoft.AnalysisServices/locations/{location}/checkNameAvailability
Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Analysisservices Locations Location Checknameavailability
microsoftAzureServersChecknameavailability 3 params body → 200default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.AnalysisServices/locations/{location}/operationresults/{operationId}
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Analysisservices Locations Location Operationresults Operationid
microsoftAzureServersListoperationresults 4 params → 200202default
GET
/subscriptions/{subscriptionId}/providers/Microsoft.AnalysisServices/locations/{location}/operationstatuses/{operationId}
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Analysisservices Locations Location Operationstatuses Operationid
microsoftAzureServersListoperationstatuses 4 params → 200202default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/servers
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Servergroupname Servers
microsoftAzureServersListbyservergroup 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/servers/{serverName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Servergroupname Servers Servername
microsoftAzureServersGet 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbformariadb Servers Servername
microsoftAzureServersCreate 4 params body → 200201202
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbformariadb Servers Servername
microsoftAzureServersUpdate 4 params body → 200202
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbformariadb Servers Servername
microsoftAzureServersDelete 4 params → 200202204
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbformariadb Servers Servername
microsoftAzureServersGet 4 params → 200
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbformariadb Servers
microsoftAzureServersListbyresourcegroup 3 params → 200
GET
/subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/servers
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Dbformariadb Servers
microsoftAzureServersList 2 params → 200

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are ServerProperties_3 (11 properties), ServerGroupServerProperties (9 properties), ServerUsage (7 properties), AnalysisServicesServerMutableProperties (7 properties). Each schema is shown below with its type and property counts.

ServerGroupServerListResult
object
A list of servers in a server group.
1 property
ServerVersion
string
The version of a server.
IPv4FirewallSettings
object
An array of firewall rules.
2 properties
ServerForCreate
object
Represents a server to be created.
4 properties 2 required
IPv4FirewallRule
object
The detail of firewall rule.
3 properties
ServerUpdateParameters
object
Parameters allowed to update for a server.
3 properties
GatewayDetails
object
The gateway details.
3 properties
ServerHaState
string
A state of a server role group/server that is visible to user for HA feature.
AnalysisServicesServerProperties
object
Properties of Analysis Services resource.
4 properties
ClusterServer
object
Represents a server in a cluster.
1 property
MinimalTlsVersion
string
Enforce a minimal Tls version for the server.
GatewayListStatusError
object
Status of gateway is error.
1 property
CitusVersion
string
The Citus version.
ClusterServerProperties
object
The properties of a server in cluster.
7 properties
GatewayError
object
Detail of gateway errors.
2 properties
ServerProperties_3
object
The properties of a server.
11 properties
SkuDetailsForExistingResource
object
An object that represents SKU details for existing resources.
1 property
ServerGroupServerProperties
object
The properties of a server in server group.
9 properties
AnalysisServicesServerMutableProperties
object
An object that represents a set of mutable Analysis Services resource properties.
7 properties
SkuEnumerationForExistingResourceResult
object
An object that represents enumerating SKUs for existing resources.
1 property
Resource
object
Represents an instance of an Analysis Services resource.
6 properties 2 required
ServerUsageListResult
object
Represents the response to a list server metrics request.
1 property 1 required
ServerGroupServer
object
Represents a server in a server group.
2 properties
ServerProperties_2
object
The properties of a server.
5 properties
ServerPropertiesForCreate
object
The properties used to create a new server.
5 properties 1 required
StorageProfile
object
Storage Profile properties of a server
4 properties
ServerUsage
object
Represents server metrics.
7 properties
ServerProperties
object
The properties of a server.
7 properties
AnalysisServicesServer
object
Represents an instance of an Analysis Services resource.
1 property
ServerAdministrators
object
An array of administrator user identities.
1 property
Sku
object
Billing information related properties of a server.
5 properties 1 required
Server
object
Represents a server.
3 properties
AnalysisServicesServerUpdateParameters
object
Provision request specification
3 properties
OperationStatus
object
The status of operation.
6 properties
ClusterServerListResult
object
A list of servers in a cluster.
1 property
FullyQualifiedDomainName
string
The fully qualified domain name of a server.
CloudErrorBody
object
An error response from the Batch service.
4 properties
ErrorResponse
object
Describes the format of Error response.
1 property
CloudError
object
An error response from the Batch service.
1 property
CheckServerNameAvailabilityResult
object
The checking result of server name availability.
3 properties
ServerState
string
A state of a server group/server that is visible to user.
ServerListResult
object
A list of servers.
1 property
AnalysisServicesServers
object
An array of Analysis Services resources.
1 property 1 required
CheckServerNameAvailabilityParameters
object
Details of server name request body.
2 properties
SslEnforcement
string
Enable ssl enforcement or not when connect to server.
ResourceIdentity
object
Azure Active Directory identity configuration for a resource.
3 properties
ErrorDetail
object
The error detail.
5 properties
ErrorAdditionalInfo
object
The resource management error additional info.
2 properties
PostgreSQLVersion
string
The PostgreSQL version.
GatewayListStatusLive
object
Status of gateway is live.
1 property
ServerRole
string
The role of a server.
ResourceSku
object
Represents the SKU name and Azure pricing tier for Analysis Services resource.
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-servers-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Servers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.