Server Azure AD Administrators - List By Server

Service:

SQL Database

API Version:

2021-11-01

Gets a list of Azure Active Directory administrators in a server.

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

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
serverName	path	True	string	The name of the server.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	AdministratorListResult	Successfully retrieved the list of Azure Active Directory administrators.
Other Status Codes		*** Error Responses: *** 400 InvalidServerAdministratorTypePropertyName - Server active directory administrator type should be ActiveDirectory 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid. 400 InvalidServerAzureADOnlyAuthenticationParameter - User tried to set AzureADOnlyAuthentication parameter to false which is not allowed, please use azureADOnlyAuthentications API instead. 400 InvalidServerAzureADAdminDeleteOperation - User tried to delete server Azure Active Azure admin when AzureADOnlyAuthentication is set, please use azureADOnlyAuthentications API first. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 ResourceNotFound - The requested resource was not found.

Examples

Gets a list of Azure Active Directory administrator.

Sample request

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

Sample response

Status code:

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
      }
    }
  ]
}

Definitions

Name	Description
AdministratorListResult	A list of active directory administrators.
AdministratorType	Type of the sever administrator.
ServerAzureADAdministrator	Azure Active Directory administrator.

AdministratorListResult

A list of active directory administrators.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	ServerAzureADAdministrator[]	Array of results.

AdministratorType

Type of the sever administrator.

Name	Type	Description
ActiveDirectory	string

ServerAzureADAdministrator

Azure Active Directory administrator.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.administratorType	AdministratorType	Type of the sever administrator.
properties.azureADOnlyAuthentication	boolean	Azure Active Directory only Authentication enabled.
properties.login	string	Login name of the server administrator.
properties.sid	string	SID (object ID) of the server administrator.
properties.tenantId	string	Tenant ID of the administrator.
type	string	Resource type.