Server Azure AD Administrators - Create Or Update

Service:

SQL Database

API Version:

2021-11-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=2021-11-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.administratorType	True	AdministratorType	Type of the sever administrator.
properties.login	True	string	Login name of the server administrator.
properties.sid	True	string	SID (object ID) of the server administrator.
properties.tenantId		string	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
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. 400 ServerAdministratorNameAlreadyExists - User tried to set the external admin and the principal name already exists in the 'master' database. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 OperationIdNotFound - The operation with Id does not exist. 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

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=2021-11-01

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

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.ServerAzureADAdministratorInner;
import com.azure.resourcemanager.sql.models.AdministratorName;
import com.azure.resourcemanager.sql.models.AdministratorType;
import java.util.UUID;

/** Samples for ServerAzureADAdministrators CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/AdministratorCreateOrUpdate.json
     */
    /**
     * Sample code: Creates or updates an existing Azure Active Directory administrator.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void createsOrUpdatesAnExistingAzureActiveDirectoryAdministrator(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerAzureADAdministrators().createOrUpdate("sqlcrudtest-4799",
            "sqlcrudtest-6440", AdministratorName.ACTIVE_DIRECTORY,
            new ServerAzureADAdministratorInner().withAdministratorType(AdministratorType.ACTIVE_DIRECTORY)
                .withLogin("bob@contoso.com").withSid(UUID.fromString("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c"))
                .withTenantId(UUID.fromString("c6b82b90-a647-49cb-8a62-0d2d3cb7ac7c")),
            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

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

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": "bob@contoso.com",
    "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.
ServerAzureADAdministrator	Azure Active Directory administrator.

AdministratorName

The name of server active directory administrator.

Name	Type	Description
ActiveDirectory	string

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.