Servers - List

Ссылка

Служба:: SQL Database

Версия API:: 2021-11-01

Возвращает список всех серверов в подписке.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Sql/servers?api-version=2021-11-01

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
subscriptionId	path	True	string	Идентификатор подписки Azure.
api-version	query	True	string	Версия API для использования в запросе.
$expand	query		string	Дочерние ресурсы, которые необходимо включить в ответ.

Ответы

Имя	Тип	Описание
200 OK	ServerListResult	Список серверов успешно получен.
Other Status Codes		Ответы на ошибки: *** 404 SubscriptionNotFound — запрошенная подписка не найдена.

Имя

Тип

Описание

200 OK

ServerListResult

Список серверов успешно получен.

Other Status Codes

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

404 SubscriptionNotFound — запрошенная подписка не найдена.

Примеры

List servers

List servers with $expand=administrators/activedirectory

List servers

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/servers?api-version=2021-11-01


/**
 * Samples for Servers List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ServerList.json
     */
    /**
     * Sample code: List servers.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listServers(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServers().list(null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

Код состояния:: 200

{
  "value": [
    {
      "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",
        "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"
              }
            }
          }
        ]
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-6661",
      "name": "sqlcrudtest-6661",
      "type": "Microsoft.Sql/servers",
      "location": "japaneast",
      "kind": "v12.0",
      "properties": {
        "fullyQualifiedDomainName": "sqlcrudtest-6661.database.windows.net",
        "administratorLogin": "dummylogin",
        "version": "12.0",
        "state": "Ready",
        "workspaceFeature": "Connected",
        "publicNetworkAccess": "Enabled",
        "restrictOutboundNetworkAccess": "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"
              }
            }
          }
        ]
      }
    }
  ]
}

List servers with $expand=administrators/activedirectory

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

HTTP
Java

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Sql/servers?api-version=2021-11-01


/**
 * Samples for Servers List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/
     * ServerListWithExpandEqualsAdministrators.json
     */
    /**
     * Sample code: List servers with $expand=administrators/activedirectory.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        listServersWithExpandAdministratorsActivedirectory(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServers().list(null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

Код состояния:: 200

{
  "value": [
    {
      "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",
        "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"
              }
            }
          }
        ]
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/servers/sqlcrudtest-6661",
      "name": "sqlcrudtest-6661",
      "type": "Microsoft.Sql/servers",
      "location": "japaneast",
      "kind": "v12.0",
      "properties": {
        "fullyQualifiedDomainName": "sqlcrudtest-6661.database.windows.net",
        "administratorLogin": "dummylogin",
        "version": "12.0",
        "state": "Ready",
        "workspaceFeature": "Connected",
        "publicNetworkAccess": "Enabled",
        "restrictOutboundNetworkAccess": "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	Тип администратора северов.
IdentityType	Тип удостоверения. Задайте для этого параметра значение SystemAssigned, чтобы автоматически создать и назначить субъект Azure Active Directory для ресурса.
PrincipalType	Тип субъекта администратора серверов.
PrivateEndpointConnectionProperties	Свойства подключения к частной конечной точке.
PrivateEndpointProperty
PrivateEndpointProvisioningState	Состояние подключения к частной конечной точке.
PrivateLinkServiceConnectionStateActionsRequire	Действия, необходимые для подключения службы приватного канала.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus	Состояние подключения службы приватного канала.
ResourceIdentity	Конфигурация удостоверений Azure Active Directory для ресурса.
Server	Сервер базы данных Azure SQL.
ServerExternalAdministrator	Свойства администратора Active Directory.
ServerListResult	Список серверов.
ServerNetworkAccessFlag	Разрешен ли доступ к общедоступной конечной точке для этого сервера. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено".
ServerPrivateEndpointConnection	Подключение к частной конечной точке на сервере
ServerWorkspaceFeature	Указывает, создана ли рабочая область на существующем сервере и разрешено ли подключение из рабочей области
UserIdentity	Конфигурация удостоверений Azure Active Directory для ресурса.

AdministratorType

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

Имя	Тип	Описание
ActiveDirectory	string

IdentityType

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

Имя	Тип	Описание
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

PrincipalType

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

Имя	Тип	Описание
Application	string
Group	string
User	string

PrivateEndpointConnectionProperties

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

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

PrivateEndpointProperty

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

PrivateEndpointProvisioningState

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

Имя	Тип	Описание
Approving	string
Dropping	string
Failed	string
Ready	string
Rejecting	string

PrivateLinkServiceConnectionStateActionsRequire

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

Имя	Тип	Описание
None	string

PrivateLinkServiceConnectionStateProperty

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

PrivateLinkServiceConnectionStateStatus

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

Имя	Тип	Описание
Approved	string
Disconnected	string
Pending	string
Rejected	string

ResourceIdentity

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

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

Server

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

Имя	Тип	Описание
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.
properties.federatedClientId	string	Идентификатор клиента, используемый для сценария CMK для нескольких клиентов
properties.fullyQualifiedDomainName	string	Полное доменное имя сервера.
properties.keyId	string	Универсальный код ресурса (URI) CMK ключа, используемого для шифрования.
properties.minimalTlsVersion	string	Минимальная версия TLS. Допустимые значения: "1.0", "1.1", "1.2"
properties.primaryUserAssignedIdentityId	string	Идентификатор ресурса удостоверения, назначаемого пользователем, который будет использоваться по умолчанию.
properties.privateEndpointConnections	ServerPrivateEndpointConnection[]	Список подключений к частной конечной точке на сервере
properties.publicNetworkAccess	ServerNetworkAccessFlag	Разрешен ли доступ к общедоступной конечной точке для этого сервера. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено".
properties.restrictOutboundNetworkAccess	ServerNetworkAccessFlag	Указывает, следует ли ограничивать исходящий сетевой доступ для этого сервера. Значение является необязательным, но при передаче должно быть "Включено" или "Отключено".
properties.state	string	Состояние сервера.
properties.version	string	Версия сервера.
properties.workspaceFeature	ServerWorkspaceFeature	Указывает, создана ли рабочая область на существующем сервере и разрешено ли подключение из рабочей области
tags	object	Теги ресурсов.
type	string	Тип ресурса.

ServerExternalAdministrator

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

Имя	Тип	Описание
administratorType	AdministratorType	Тип администратора северов.
azureADOnlyAuthentication	boolean	Включена только проверка подлинности Azure Active Directory.
login	string	Имя входа администратора сервера.
principalType	PrincipalType	Тип субъекта администратора серверов.
sid	string	SID (идентификатор объекта) администратора сервера.
tenantId	string	Идентификатор клиента администратора.

ServerListResult

Список серверов.

Имя	Тип	Описание
nextLink	string	Ссылка для получения следующей страницы результатов.
value	Server[]	Массив результатов.

ServerNetworkAccessFlag

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

Имя	Тип	Описание
Disabled	string
Enabled	string

ServerPrivateEndpointConnection

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

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

ServerWorkspaceFeature

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

Имя	Тип	Описание
Connected	string
Disconnected	string

UserIdentity

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

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

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

Servers - List

Параметры URI

Ответы

Примеры

List servers

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

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

List servers with $expand=administrators/activedirectory

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

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

Определения

AdministratorType

IdentityType

PrincipalType

PrivateEndpointConnectionProperties

PrivateEndpointProperty

PrivateEndpointProvisioningState

PrivateLinkServiceConnectionStateActionsRequire

PrivateLinkServiceConnectionStateProperty

PrivateLinkServiceConnectionStateStatus

ResourceIdentity

Server

ServerExternalAdministrator

ServerListResult

ServerNetworkAccessFlag

ServerPrivateEndpointConnection

ServerWorkspaceFeature

UserIdentity

Дополнительные ресурсы