Server Azure AD Administrators - Get

Служба:

SQL Database

Версия API:

2025-01-01

Получает администратор Azure Active Directory.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
administratorName	path	True	AdministratorName	Имя администратора Active Directory сервера.
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, используемая для данной операции.

Ответы

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

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

azure_auth

Поток OAuth2 в Azure Active Directory.

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

Области

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

Примеры

Gets a 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/ActiveDirectory?api-version=2025-01-01

Java

import com.azure.resourcemanager.sql.models.AdministratorName;

/**
 * Samples for ServerAzureADAdministrators Get.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-01-01/AdministratorGet.json
     */
    /**
     * Sample code: Gets a Azure Active Directory administrator.
     * 
     * @param manager Entry point to SqlServerManager.
     */
    public static void getsAAzureActiveDirectoryAdministrator(com.azure.resourcemanager.sql.SqlServerManager manager) {
        manager.serviceClient().getServerAzureADAdministrators().getWithResponse("sqlcrudtest-4799", "sqlcrudtest-6440",
            AdministratorName.ACTIVE_DIRECTORY, 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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.sql import SqlManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-sql
# USAGE
    python administrator_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SqlManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.server_azure_ad_administrators.get(
        resource_group_name="sqlcrudtest-4799",
        server_name="sqlcrudtest-6440",
        administrator_name="ActiveDirectory",
    )
    print(response)


# x-ms-original-file: 2025-01-01/AdministratorGet.json
if __name__ == "__main__":
    main()

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

JavaScript

const { SqlManagementClient } = require("@azure/arm-sql");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to gets a Azure Active Directory administrator.
 *
 * @summary gets a Azure Active Directory administrator.
 * x-ms-original-file: 2025-01-01/AdministratorGet.json
 */
async function getsAAzureActiveDirectoryAdministrator() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-1111-2222-3333-444444444444";
  const client = new SqlManagementClient(credential, subscriptionId);
  const result = await client.serverAzureADAdministrators.get(
    "sqlcrudtest-4799",
    "sqlcrudtest-6440",
    "ActiveDirectory",
  );
  console.log(result);
}

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/SQL/stable/2025-01-01/examples/AdministratorGet.json
// this example is just showing the usage of "ServerAzureADAdministrators_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SqlServerResource created on azure
// for more information of creating SqlServerResource, please refer to the document of SqlServerResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "sqlcrudtest-4799";
string serverName = "sqlcrudtest-6440";
ResourceIdentifier sqlServerResourceId = SqlServerResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serverName);
SqlServerResource sqlServer = client.GetSqlServerResource(sqlServerResourceId);

// get the collection of this SqlServerAzureADAdministratorResource
SqlServerAzureADAdministratorCollection collection = sqlServer.GetSqlServerAzureADAdministrators();

// invoke the operation
SqlAdministratorName administratorName = SqlAdministratorName.ActiveDirectory;
NullableResponse<SqlServerAzureADAdministratorResource> response = await collection.GetIfExistsAsync(administratorName);
SqlServerAzureADAdministratorResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SqlServerAzureADAdministratorData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

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

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

200

{
  "name": "ActiveDirectory",
  "type": "Microsoft.Sql/servers/administrators",
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-6440/administrators/ActiveDirectory",
  "properties": {
    "administratorType": "ActiveDirectory",
    "azureADOnlyAuthentication": true,
    "login": "bob@contoso.com",
    "sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
    "tenantId": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"
  }
}

Определения

Имя	Описание
AdministratorName	Имя администратора Active Directory сервера.
AdministratorType	Тип администратора развера.
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Ошибка управления ресурсами дополнительная информация.
ErrorDetail	Детали ошибки.
ErrorResponse	Ответ на ошибку
ServerAzureADAdministrator	Azure Active Directory administrator.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.

AdministratorName

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

Имя администратора Active Directory сервера.

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

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	Объект ошибки.

ServerAzureADAdministrator

Объект

Azure Active Directory administrator.

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Имя ресурса
properties.administratorType	AdministratorType	Тип администратора развера.
properties.azureADOnlyAuthentication	boolean	Azure Active Directory only Authentication включена.
properties.login	string	Имя входа администратора сервера.
properties.sid	string (uuid)	ИДЕНТИФИКАТОР безопасности (идентификатор объекта) администратора сервера.
properties.tenantId	string (uuid)	Идентификатор клиента администратора.
systemData	systemData	Azure Resource Manager метаданные, содержащие информацию createdBy и modifiedBy.
type	string	Тип ресурса. Например, «Microsoft. Compute/virtualMachines» или «Microsoft. Аккаунты хранения/хранения»

systemData

Объект

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

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