Server Azure AD Administrators - List By Server

Служба:

SQL Database

Версия API:

2021-11-01

Возвращает список администраторов Azure Active Directory на сервере.

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

Параметры URI

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

Ответы

Имя	Тип	Описание
200 OK	AdministratorListResult	Список администраторов Azure Active Directory успешно получен.
Other Status Codes		Ответы об ошибках: *** 400 InvalidServerAdministratorTypePropertyName — тип администратора Active Directory сервера должен иметь значение ActiveDirectory 400 InvalidResourceRequestBody — свойства ресурса или ресурса в тексте запроса пусты или недопустимы. 400 InvalidServerAzureADOnlyAuthenticationParameter — пользователь попытался задать для параметра AzureADOnlyAuthentication значение false, что не разрешено. Вместо этого используйте API azureADOnlyAuthentications. 400 InvalidServerAzureADminDeleteOperation — пользователь пытался удалить сервер Azure Active Azure Admin, если задано значение AzureADOnlyAuthentication. Сначала используйте API azureADOnlyAuthentications. 404 SubscriptionDoesNotHaveServer — запрошенный сервер не найден. 404 ServerNotInSubscriptionResourceGroup — указанный сервер не существует в указанной группе ресурсов и подписке. 404 ResourceNotFound — запрошенный ресурс не найден.

Примеры

Gets a list of Azure Active Directory administrator.

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

HTTP

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

Java

/**
 * Samples for ServerAzureADAdministrators ListByServer.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/AdministratorList.json
     */
    /**
     * Sample code: Gets a list of Azure Active Directory administrator.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getsAListOfAzureActiveDirectoryAdministrator(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerAzureADAdministrators().listByServer("sqlcrudtest-4799",
            "sqlcrudtest-6440", 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-4799/providers/Microsoft.Sql/servers/sqlcrudtest-6440/administrators/ActiveDirectory",
      "name": "ActiveDirectory",
      "type": "Microsoft.Sql/servers/administrators",
      "properties": {
        "administratorType": "ActiveDirectory",
        "login": "bob@contoso.com",
        "sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
        "tenantId": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
        "azureADOnlyAuthentication": true
      }
    }
  ]
}

Определения

Имя	Описание
AdministratorListResult	Список администраторов Active Directory.
AdministratorType	Тип администратора серверов.
ServerAzureADAdministrator	администратор Azure Active Directory;

AdministratorListResult

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

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

AdministratorType

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

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

ServerAzureADAdministrator

администратор Azure Active Directory;

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