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}?api-version=2025-01-01&$expand={$expand}

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя регистронезависимо.
serverName	path	True	string	Имени сервера.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.
$expand	query		string	Дочерние ресурсы для включения в ответ.

Ответы

Имя	Тип	Описание
200 OK	Server	Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

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

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

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

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

Определения

Имя	Описание
AdministratorType	Тип администратора развера.
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Ошибка управления ресурсами дополнительная информация.
ErrorDetail	Детали ошибки.
ErrorResponse	Ответ на ошибку
ExternalGovernanceStatus	Состояние внешнего управления.
IdentityType	Тип удостоверения. Установите это на '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 identity configuration for a resource.
Server	Сервер База данных SQL Azure.
ServerCreateMode	Режим создания для сервера, единственными допустимыми значениями для него являются Normal и Restore.
ServerExternalAdministrator	Свойства администратора Active Directory.
ServerNetworkAccessFlag	Независимо от того, следует ли ограничить исходящий сетевой доступ для этого сервера. Значение является необязательным, но при передаче в нее должно быть включено или отключено.
ServerPrivateEndpointConnection	Подключение частной конечной точки под сервером
ServerPublicNetworkAccessFlag	Допускается ли доступ к общедоступной конечной точке для этого сервера. Значение является необязательным, но при передаче должно быть включено или "Отключено" или "SecuredByPerimeter"
ServerWorkspaceFeature	Существует ли существующий сервер созданную рабочую область, и если она разрешает подключение из рабочей области
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
UserIdentity	Azure Active Directory identity configuration for a resource.

AdministratorType

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

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

Значение	Описание
ActiveDirectory	Служба ActiveDirectory

createdByType

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

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Объект

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

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

ErrorDetail

Объект

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

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

ErrorResponse

Объект

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

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

ExternalGovernanceStatus

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

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

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

IdentityType

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

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

Значение	Описание
None	Нет
SystemAssigned	Системное назначение
UserAssigned	UserAssigned
SystemAssigned,UserAssigned	SystemAssigned,UserAssigned

MinimalTlsVersion

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

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

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

PrincipalType

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

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

Значение	Описание
User	User
Group	Группа
Application	Заявление

PrivateEndpointConnectionProperties

Объект

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

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

PrivateEndpointProperty

Объект

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

PrivateEndpointProvisioningState

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

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

Значение	Описание
Approving	Утверждение
Ready	Ready
Dropping	Сброс
Failed	Неудача
Rejecting	Отказ

PrivateLinkServiceConnectionStateActionsRequire

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

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

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

PrivateLinkServiceConnectionStateProperty

Объект

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

PrivateLinkServiceConnectionStateStatus

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

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

Значение	Описание
Approved	Утверждено
Pending	В ожидании
Rejected	Отклонено
Disconnected	Отключен

ResourceIdentity

Объект

Azure Active Directory identity configuration for a resource.

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

Server

Объект

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

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ResourceIdentity	Идентичность сервера Azure Active Directory.
kind	string	Тип SQL Server. Это метаданные, используемые для работы с порталом Azure.
location	string	Географическое расположение, в котором находится ресурс
name	string	Имя ресурса
properties.administratorLogin	string	Имя администратора сервера. После создания его нельзя изменить.
properties.administratorLoginPassword	string (password)	Пароль для входа администратора (требуется для создания сервера).
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	Существует ли существующий сервер созданную рабочую область, и если она разрешает подключение из рабочей области
systemData	systemData	Azure Resource Manager метаданные, содержащие информацию createdBy и modifiedBy.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, «Майкрософт. Compute/virtualMachines» или «Майкрософт. Аккаунты хранения/хранения»

ServerCreateMode

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

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

Значение	Описание
Normal	Нормальный
Restore	Restore

ServerExternalAdministrator

Объект

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

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

ServerNetworkAccessFlag

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

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

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

ServerPrivateEndpointConnection

Объект

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

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

ServerPublicNetworkAccessFlag

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

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

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

ServerWorkspaceFeature

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

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

Значение	Описание
Connected	Подключен
Disconnected	Отключен

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Временная метка последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

UserIdentity

Объект

Azure Active Directory identity configuration for a resource.

Имя	Тип	Описание
clientId	string (uuid)	The Azure Active Directory client id.
principalId	string (uuid)	The Azure Active Directory principal id.