Share via

Servers - Get

  • Reference
Service:
SQL Database
API Version:
2023-08-01

Gets a server.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}?api-version=2023-08-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}?$expand={$expand}&api-version=2023-08-01

URI Parameters

Name In Required Type Description
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.
subscriptionId
 path True

string

The subscription ID that identifies an Azure subscription.
api-version
 query True

string

The API version to use for the request.
$expand
 query

string

The child resources to include in the response.

Responses

Name Type Description
200 OK

Server

Successfully retrieved the specified server.
Other Status Codes

ErrorResponse

*** Error Responses: ***

  • 404 SubscriptionNotFound - The requested subscription was not found.

  • 404 ResourceNotFound - The requested resource was not found.

  • 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.

  • 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Examples

Get server
Get server with $expand=administrators/activedirectory

Get server

Sample request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645?api-version=2023-08-01

Sample response

Status code:
200 
{
  "tags": {
    "tagKey1": "TagValue1"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645",
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers",
  "location": "japaneast",
  "kind": "v12.0",
  "properties": {
    "fullyQualifiedDomainName": "sqlcrudtest-4645.database.windows.net",
    "administratorLogin": "dummylogin",
    "version": "12.0",
    "state": "Ready",
    "workspaceFeature": "Connected",
    "publicNetworkAccess": "Enabled",
    "restrictOutboundNetworkAccess": "Enabled",
    "isIPv6Enabled": "Enabled",
    "externalGovernanceStatus": "Enabled",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/privateEndpointConnections/private-endpoint-name-00000000-1111-2222-3333-444444444444",
        "properties": {
          "provisioningState": "Ready",
          "privateEndpoint": {
            "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Auto-approved",
            "actionsRequired": "None"
          }
        }
      }
    ]
  }
}

Get server with $expand=administrators/activedirectory

Sample request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645?api-version=2023-08-01

Sample response

Status code:
200 
{
  "tags": {
    "tagKey1": "TagValue1"
  },
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645",
  "name": "sqlcrudtest-4645",
  "type": "Microsoft.Sql/servers",
  "location": "japaneast",
  "kind": "v12.0",
  "properties": {
    "fullyQualifiedDomainName": "sqlcrudtest-4645.database.windows.net",
    "administratorLogin": "dummylogin",
    "version": "12.0",
    "state": "Ready",
    "workspaceFeature": "Connected",
    "publicNetworkAccess": "Enabled",
    "restrictOutboundNetworkAccess": "Enabled",
    "isIPv6Enabled": "Enabled",
    "externalGovernanceStatus": "Enabled",
    "administrators": {
      "principalType": "User",
      "login": "bob@contoso.com",
      "sid": "00000011-1111-2222-2222-123456789111",
      "tenantId": "00000011-1111-2222-2222-123456789111",
      "azureADOnlyAuthentication": true
    },
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-4645/privateEndpointConnections/private-endpoint-name-00000000-1111-2222-3333-444444444444",
        "properties": {
          "provisioningState": "Ready",
          "privateEndpoint": {
            "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Auto-approved",
            "actionsRequired": "None"
          }
        }
      }
    ]
  }
}

Definitions

Name Description
AdministratorType

Type of the sever administrator.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
ExternalGovernanceStatus

Status of external governance.
IdentityType

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

Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3'
PrincipalType

Principal Type of the sever administrator.
PrivateEndpointConnectionProperties

Properties of a private endpoint connection.
PrivateEndpointProperty
PrivateEndpointProvisioningState

State of the private endpoint connection.
PrivateLinkServiceConnectionStateActionsRequire

The actions required for private link service connection.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus

The private link service connection status.
ResourceIdentity

Azure Active Directory identity configuration for a resource.
Server

An Azure SQL Database server.
ServerExternalAdministrator

Properties of a active directory administrator.
ServerNetworkAccessFlag

Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
ServerPrivateEndpointConnection

A private endpoint connection under a server
ServerPublicNetworkAccessFlag

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

Whether or not existing server has a workspace created and if it allows connection from workspace
UserIdentity

Azure Active Directory identity configuration for a resource.

AdministratorType

Enumeration

Type of the sever administrator.

Value Description
ActiveDirectory

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Object

Error response

Name Type Description
error

ErrorDetail

The error object.

ExternalGovernanceStatus

Enumeration

Status of external governance.

Value Description
Disabled
Enabled

IdentityType

Enumeration

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

Value Description
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

MinimalTlsVersion

Enumeration

Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3'

Value Description
1.0
1.1
1.2
1.3
None

PrincipalType

Enumeration

Principal Type of the sever administrator.

Value Description
Application
Group
User

PrivateEndpointConnectionProperties

Object

Properties of a private endpoint connection.

Name Type Description
groupIds

string[]

Group IDs.
privateEndpoint

PrivateEndpointProperty

Private endpoint which the connection belongs to.
privateLinkServiceConnectionState

PrivateLinkServiceConnectionStateProperty

Connection state of the private endpoint connection.
provisioningState

PrivateEndpointProvisioningState

State of the private endpoint connection.

PrivateEndpointProperty

Object
Name Type Description
id

string

Resource id of the private endpoint.

PrivateEndpointProvisioningState

Enumeration

State of the private endpoint connection.

Value Description
Approving
Dropping
Failed
Ready
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

Enumeration

The actions required for private link service connection.

Value Description
None

PrivateLinkServiceConnectionStateProperty

Object
Name Type Description
actionsRequired

PrivateLinkServiceConnectionStateActionsRequire

The actions required for private link service connection.
description

string

The private link service connection description.
status

PrivateLinkServiceConnectionStateStatus

The private link service connection status.

PrivateLinkServiceConnectionStateStatus

Enumeration

The private link service connection status.

Value Description
Approved
Disconnected
Pending
Rejected

ResourceIdentity

Object

Azure Active Directory identity configuration for a resource.

Name Type Description
principalId

string (uuid)

The Azure Active Directory principal id.
tenantId

string (uuid)

The Azure Active Directory tenant id.
type

IdentityType

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

<string,  UserIdentity>

The resource ids of the user assigned identities to use

Server

Object

An Azure SQL Database server.

Name Type Description
id

string

Resource ID.
identity

ResourceIdentity

The Azure Active Directory identity of the server.
kind

string

Kind of sql server. This is metadata used for the Azure portal experience.
location

string

Resource location.
name

string

Resource name.
properties.administratorLogin

string

Administrator username for the server. Once created it cannot be changed.
properties.administratorLoginPassword

string

The administrator login password (required for server creation).
properties.administrators

ServerExternalAdministrator

The Azure Active Directory administrator of the server. This can only be used at server create time. If used for server update, it will be ignored or it will result in an error. For updates individual APIs will need to be used.
properties.externalGovernanceStatus

ExternalGovernanceStatus

Status of external governance.
properties.federatedClientId

string (uuid)

The Client id used for cross tenant CMK scenario
properties.fullyQualifiedDomainName

string

The fully qualified domain name of the server.
properties.isIPv6Enabled

ServerNetworkAccessFlag

Whether or not to enable IPv6 support for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
properties.keyId

string

A CMK URI of the key to use for encryption.
properties.minimalTlsVersion

MinimalTlsVersion

Minimal TLS version. Allowed values: 'None', 1.0', '1.1', '1.2', '1.3'
properties.primaryUserAssignedIdentityId

string

The resource id of a user assigned identity to be used by default.
properties.privateEndpointConnections

ServerPrivateEndpointConnection[]

List of private endpoint connections on a server
properties.publicNetworkAccess

ServerPublicNetworkAccessFlag

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

ServerNetworkAccessFlag

Whether or not to restrict outbound network access for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled'
properties.state

string

The state of the server.
properties.version

string

The version of the server.
properties.workspaceFeature

ServerWorkspaceFeature

Whether or not existing server has a workspace created and if it allows connection from workspace
tags

object

Resource tags.
type

string

Resource type.

ServerExternalAdministrator

Object

Properties of a active directory administrator.

Name Type Description
administratorType

AdministratorType

Type of the sever administrator.
azureADOnlyAuthentication

boolean

Azure Active Directory only Authentication enabled.
login

string

Login name of the server administrator.
principalType

PrincipalType

Principal Type of the sever administrator.
sid

string (uuid)

SID (object ID) of the server administrator.
tenantId

string (uuid)

Tenant ID of the administrator.

ServerNetworkAccessFlag

Enumeration

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

Value Description
Disabled
Enabled

ServerPrivateEndpointConnection

Object

A private endpoint connection under a server

Name Type Description
id

string

Resource ID.
properties

PrivateEndpointConnectionProperties

Private endpoint connection properties

ServerPublicNetworkAccessFlag

Enumeration

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

Value Description
Disabled
Enabled
SecuredByPerimeter

ServerWorkspaceFeature

Enumeration

Whether or not existing server has a workspace created and if it allows connection from workspace

Value Description
Connected
Disconnected

UserIdentity

Object

Azure Active Directory identity configuration for a resource.

Name Type Description
clientId

string (uuid)

The Azure Active Directory client id.
principalId

string (uuid)

The Azure Active Directory principal id.