Server Azure AD Administrators - Create Or Update

Reference

Service:: SQL Database

API Version:: 2014-04-01

Creates a new Server Active Directory Administrator or updates an existing server Active Directory Administrator.

PUT 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.

Request Body

Name	Required	Type	Description
properties.administratorType	True	AdministratorType	The type of administrator.
properties.login	True	string	The server administrator login value.
properties.sid	True	string	The server administrator Sid (Secure ID).
properties.tenantId	True	string	The server Active Directory Administrator tenant id.

Responses

Name	Type	Description
200 OK	ServerAzureADAdministrator	OK
201 Created	ServerAzureADAdministrator	Created
202 Accepted	ServerAzureADAdministrator	Accepted

Examples

Create/Update a server administrator

Sample request

HTTP

PUT 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

{
  "name": "activeDirectory",
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "bob@contoso.com",
    "sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
    "tenantId": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"
  }
}

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

Status code:: 201

"Created"

Status code:: 202

"Accepted"

Definitions

Name	Description
AdministratorType	The type of administrator.
ServerAdministratorName	Name of the server administrator resource.
ServerAzureADAdministrator	An server Active Directory Administrator.

AdministratorType

The type of administrator.

Name	Type	Description
ActiveDirectory	string

ServerAdministratorName

Name of the server administrator resource.

Name	Type	Description
activeDirectory	string

ServerAzureADAdministrator

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	The server administrator Sid (Secure ID).
properties.tenantId	string	The server Active Directory Administrator tenant id.
type	string	Resource type.

Share via