Servers - Get

Служба:: SQL Database

Версия API:: 2025-01-01

Получает доступ к серверу.

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

С использованием необязательных параметров:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string	Имя группы ресурсов, содержащей ресурс. Это значение можно получить из API Azure Resource Manager или портала.
serverName	path	True	string	Имени сервера.
subscriptionId	path	True	string	Идентификатор подписки, идентифицирующий подписку Azure.
api-version	query	True	string	Версия API, используемая для запроса.
$expand	query		string	Дочерние ресурсы для включения в ответ.

Ответы

Имя	Тип	Описание
200 OK	Server	Успешно получен указанный сервер.
Other Status Codes	ErrorResponse	Ответы на ошибки: *** 404 SubscriptionNotFound — запрошенная подписка не найдена. 404 ResourceNotFound — запрошенный ресурс не найден. 429 SubscriptionTooManyRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами. 503 TooManyRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами.

Имя

Тип

Описание

200 OK

Server

Успешно получен указанный сервер.

Other Status Codes

ErrorResponse

Ответы на ошибки: ***

404 SubscriptionNotFound — запрошенная подписка не найдена.
404 ResourceNotFound — запрошенный ресурс не найден.
429 SubscriptionTooManyRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами.
503 TooManyRequests — запросы, превышающие максимальные запросы, которые могут обрабатываться доступными ресурсами.

Примеры

Get server

Get server with $expand=administrators/activedirectory

Get server

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 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",
    "retentionDays": 7,
    "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

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 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",
    "retentionDays": 7,
    "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"
          }
        }
      }
    ]
  }
}

Определения

Имя	Описание
AdministratorType	Тип администратора развера.
ErrorAdditionalInfo	Ошибка управления ресурсами дополнительная информация.
ErrorDetail	Детали ошибки.
ErrorResponse	Ответ на ошибку
ExternalGovernanceStatus	Состояние внешнего управления.
IdentityType	Тип удостоверения. Установите для параметра SystemAssigned значение SystemAssigned, чтобы автоматически создать и назначить субъект Azure Active Directory для ресурса.
MinimalTlsVersion	Минимальная версия TLS. Допустимые значения: None, 1.0, "1.1", "1.2", "1.3"
PrincipalType	Тип субъекта-администратора.
PrivateEndpointConnectionProperties	Свойства подключения частной конечной точки.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Состояние подключения частной конечной точки.
PrivateLinkServiceConnectionStateActionsRequire	Действия, необходимые для подключения службы приватного канала.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	Состояние подключения службы приватного канала.
ResourceIdentity	Конфигурация удостоверений Azure Active Directory для ресурса.
Server	Сервер базы данных SQL Azure.
ServerCreateMode	Режим создания для сервера, единственными допустимыми значениями для него являются Normal и Restore.
ServerExternalAdministrator	Свойства администратора Active Directory.
ServerNetworkAccessFlag	Независимо от того, следует ли ограничить исходящий сетевой доступ для этого сервера. Значение является необязательным, но при передаче в нее должно быть включено или отключено.
ServerPrivateEndpointConnection	Подключение частной конечной точки под сервером
ServerPublicNetworkAccessFlag	Допускается ли доступ к общедоступной конечной точке для этого сервера. Значение является необязательным, но при передаче должно быть включено или "Отключено" или "SecuredByPerimeter"
ServerWorkspaceFeature	Существует ли существующий сервер созданную рабочую область, и если она разрешает подключение из рабочей области
UserIdentity	Конфигурация удостоверений Azure Active Directory для ресурса.

AdministratorType

Перечисление

Тип администратора развера.

Значение	Описание
ActiveDirectory

ErrorAdditionalInfo

Объект

Ошибка управления ресурсами дополнительная информация.

Имя	Тип	Описание
info	object	Дополнительная информация.
type	string	Тип дополнительной информации.

ErrorDetail

Объект

Детали ошибки.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Ошибка дополнительная информация.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

ExternalGovernanceStatus

Перечисление

Состояние внешнего управления.

Значение	Описание
Enabled
Disabled

IdentityType

Перечисление

Тип удостоверения. Установите для параметра SystemAssigned значение SystemAssigned, чтобы автоматически создать и назначить субъект Azure Active Directory для ресурса.

Значение	Описание
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

MinimalTlsVersion

Перечисление

Минимальная версия TLS. Допустимые значения: None, 1.0, "1.1", "1.2", "1.3"

Значение	Описание
None
1.0
1.1
1.2
1.3

PrincipalType

Перечисление

Тип субъекта-администратора.

Значение	Описание
User
Group
Application

PrivateEndpointConnectionProperties

Объект

Свойства подключения частной конечной точки.

Имя	Тип	Описание
groupIds	string[]	Идентификаторы групп.
privateEndpoint	PrivateEndpointProperty	Частная конечная точка, к которой принадлежит подключение.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Состояние подключения частной конечной точки.
provisioningState	PrivateEndpointProvisioningState	Состояние подключения частной конечной точки.

PrivateEndpointProperty

Объект

Имя	Тип	Описание
id	string	Идентификатор ресурса частной конечной точки.

PrivateEndpointProvisioningState

Перечисление

Состояние подключения частной конечной точки.

Значение	Описание
Approving
Ready
Dropping
Failed
Rejecting

PrivateLinkServiceConnectionStateActionsRequire

Перечисление

Действия, необходимые для подключения службы приватного канала.

Значение	Описание
None

PrivateLinkServiceConnectionStateProperty

Объект

Имя	Тип	Описание
actionsRequired	PrivateLinkServiceConnectionStateActionsRequire	Действия, необходимые для подключения службы приватного канала.
description	string	Описание подключения службы приватного канала.
status	PrivateLinkServiceConnectionStateStatus	Состояние подключения службы приватного канала.

PrivateLinkServiceConnectionStateStatus

Перечисление

Состояние подключения службы приватного канала.

Значение	Описание
Approved
Pending
Rejected
Disconnected

ResourceIdentity

Объект

Конфигурация удостоверений Azure Active Directory для ресурса.

Имя	Тип	Описание
principalId	string (uuid)	Идентификатор субъекта Azure Active Directory.
tenantId	string (uuid)	Идентификатор клиента Azure Active Directory.
type	IdentityType	Тип удостоверения. Установите для параметра SystemAssigned значение SystemAssigned, чтобы автоматически создать и назначить субъект Azure Active Directory для ресурса.
userAssignedIdentities	<string, UserIdentity>	Идентификаторы ресурса назначенных пользователем удостоверений для использования

Server

Объект

Сервер базы данных SQL Azure.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
identity	ResourceIdentity	Удостоверение Azure Active Directory сервера.
kind	string	Тип SQL Server. Это метаданные, используемые для интерфейса портала Azure.
location	string	Расположение ресурса.
name	string	Имя ресурса.
properties.administratorLogin	string	Имя администратора сервера. После создания его нельзя изменить.
properties.administratorLoginPassword	string	Пароль для входа администратора (требуется для создания сервера).
properties.administrators	ServerExternalAdministrator	Администратора Azure Active Directory можно использовать во время создания сервера и для его обновления, за исключением свойства azureADOnlyAuthentication. Чтобы обновить свойство azureADOnlyAuthentication, необходимо использовать отдельный API.
properties.createMode	ServerCreateMode	Режим создания для сервера, единственными допустимыми значениями для него являются Normal и Restore.
properties.externalGovernanceStatus	ExternalGovernanceStatus	Состояние внешнего управления.
properties.federatedClientId	string (uuid)	Идентификатор клиента, используемый для сценария CMK между клиентами
properties.fullyQualifiedDomainName	string	Полное доменное имя сервера.
properties.isIPv6Enabled	ServerNetworkAccessFlag	Следует ли включить поддержку IPv6 для этого сервера. Значение является необязательным, но при передаче в нее должно быть включено или отключено.
properties.keyId	string	Универсальный код ресурса (URI) ключа для шифрования.
properties.minimalTlsVersion	MinimalTlsVersion	Минимальная версия TLS. Допустимые значения: None, 1.0, "1.1", "1.2", "1.3"
properties.primaryUserAssignedIdentityId	string	Идентификатор ресурса назначаемого пользователем удостоверения, используемого по умолчанию.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Список подключений к частной конечной точке на сервере
properties.publicNetworkAccess	ServerPublicNetworkAccessFlag	Допускается ли доступ к общедоступной конечной точке для этого сервера. Значение является необязательным, но при передаче должно быть включено или "Отключено" или "SecuredByPerimeter"
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Независимо от того, следует ли ограничить исходящий сетевой доступ для этого сервера. Значение является необязательным, но при передаче в нее должно быть включено или отключено.
properties.retentionDays	integer (int32)	Количество дней, в течение которых этот сервер будет оставаться обратимо удаленным.
properties.state	string	Состояние сервера.
properties.version	string	Версия сервера.
properties.workspaceFeature	ServerWorkspaceFeature	Существует ли существующий сервер созданную рабочую область, и если она разрешает подключение из рабочей области
tags	object	Теги ресурсов.
type	string	Тип ресурса.

ServerCreateMode

Перечисление

Режим создания для сервера, единственными допустимыми значениями для него являются Normal и Restore.

Значение	Описание
Normal
Restore

ServerExternalAdministrator

Объект

Свойства администратора Active Directory.

Имя	Тип	Описание
administratorType	AdministratorType	Тип администратора развера.
azureADOnlyAuthentication	boolean	Включена только проверка подлинности Azure Active Directory.
login	string	Имя входа администратора сервера.
principalType	PrincipalType	Тип субъекта-администратора.
sid	string (uuid)	ИДЕНТИФИКАТОР безопасности (идентификатор объекта) администратора сервера.
tenantId	string (uuid)	Идентификатор клиента администратора.

ServerNetworkAccessFlag

Перечисление

Независимо от того, следует ли ограничить исходящий сетевой доступ для этого сервера. Значение является необязательным, но при передаче в нее должно быть включено или отключено.

Значение	Описание
Enabled
Disabled

ServerPrivateEndpointConnection

Объект

Подключение частной конечной точки под сервером

Имя	Тип	Описание
id	string	Идентификатор ресурса.
properties	PrivateEndpointConnectionProperties	Свойства подключения к частной конечной точке

ServerPublicNetworkAccessFlag

Перечисление

Допускается ли доступ к общедоступной конечной точке для этого сервера. Значение является необязательным, но при передаче должно быть включено или "Отключено" или "SecuredByPerimeter"

Значение	Описание
Enabled
Disabled
SecuredByPerimeter

ServerWorkspaceFeature

Перечисление

Существует ли существующий сервер созданную рабочую область, и если она разрешает подключение из рабочей области

Значение	Описание
Connected
Disconnected

UserIdentity

Объект

Конфигурация удостоверений Azure Active Directory для ресурса.

Имя	Тип	Описание
clientId	string (uuid)	Идентификатор клиента Azure Active Directory.
principalId	string (uuid)	Идентификатор субъекта Azure Active Directory.

Поделиться через

Servers - Get

Параметры URI

Ответы

Примеры

Get server

Образец запроса

Пример ответа

Get server with $expand=administrators/activedirectory

Образец запроса

Пример ответа

Определения

AdministratorType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExternalGovernanceStatus

IdentityType

MinimalTlsVersion

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerCreateMode

ServerExternalAdministrator

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerPublicNetworkAccessFlag

ServerWorkspaceFeature

UserIdentity