Share via

Server Azure AD Administrators - Create Or Update

  • Reference
Service:
SQL Database
API Version:
2023-08-01

Creates or updates an existing Azure Active Directory administrator.

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

URI Parameters

Name In Required Type Description
administratorName
 path True

AdministratorName

The name of server active directory administrator.
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.login True

string

Login name of the server administrator.
properties.sid True

string (uuid)

SID (object ID) of the server administrator.
properties.administratorType

AdministratorType

Type of the sever administrator.
properties.tenantId

string (uuid)

Tenant ID of the administrator.

Responses

Name Type Description
200 OK

ServerAzureADAdministrator

Successfully updated a Azure Active Directory administrator.
201 Created

ServerAzureADAdministrator

Successfully created a Azure Active Directory administrator.
202 Accepted

Accepted

Headers

Location: string
Other Status Codes

ErrorResponse

*** Error Responses: ***

  • 400 ManagedInstanceStoppingOrStopped - Conflicting operation submitted while instance is in stopping/stopped state

  • 400 ManagedInstanceStarting - Conflicting operation submitted while instance is in starting state

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

  • 400 ServerAdministratorNameAlreadyExists - User tried to set the external admin and the principal name already exists in the 'master' database.

  • 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

  • 404 OperationIdNotFound - The operation with Id does not exist.

  • 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.

  • 409 OperationCancelled - The operation has been cancelled by user.

  • 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.

  • 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.

  • 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.

  • 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.

  • 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.

Examples

Creates or updates an existing Azure Active Directory administrator.

Sample request

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

{
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "[email protected]",
    "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",
  "type": "Microsoft.Sql/servers/administrators",
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "[email protected]",
    "sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
    "tenantId": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
    "azureADOnlyAuthentication": true
  }
}
Status code:
201 
{
  "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": "[email protected]",
    "sid": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
    "tenantId": "c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c",
    "azureADOnlyAuthentication": true
  }
}
Status code:
202

Definitions

Name Description
AdministratorName

The name of server active directory administrator.
AdministratorType

Type of the sever administrator.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
ServerAzureADAdministrator

Azure Active Directory administrator.

AdministratorName

Enumeration

The name of server active directory administrator.

Value Description
ActiveDirectory

AdministratorType

Enumeration

Type of the sever administrator.

Value Description
ActiveDirectory

ErrorAdditionalInfo

Object

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

Object

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Object

Error response

Name Type Description
error

ErrorDetail

The error object.

ServerAzureADAdministrator

Object

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 (uuid)

SID (object ID) of the server administrator.
properties.tenantId

string (uuid)

Tenant ID of the administrator.
type

string

Resource type.