Share via

Server Azure AD Administrators - Get

Service:
SQL Database
API Version:
2014-04-01

Returns an server Administrator.

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

URI Parameters

Name In Required Type Description
administratorName
 path True

ServerAdministratorName

Name of the server administrator resource.
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

ServerAzureADAdministrator

OK

Examples

Get the Active Directory Administrator

Sample request

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

Sample response

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

Definitions

Name Description
AdministratorType

The type of administrator.
ServerAdministratorName

Name of the server administrator resource.
ServerAzureADAdministrator

An server Active Directory Administrator.

AdministratorType

Enumeration

The type of administrator.

Value Description
ActiveDirectory

ServerAdministratorName

Enumeration

Name of the server administrator resource.

Value Description
activeDirectory

ServerAzureADAdministrator

Object

An server Active Directory Administrator.

Name Type Description
id

string

Resource ID.
name

string

Resource name.
properties.administratorType

AdministratorType

The type of administrator.
properties.login

string

The server administrator login value.
properties.sid

string (uuid)

The server administrator Sid (Secure ID).
properties.tenantId

string (uuid)

The server Active Directory Administrator tenant id.
type

string

Resource type.