Share via

Server Azure AD Only Authentications - Create Or Update

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

Sets Server Active Directory only authentication property or updates an existing server Active Directory only authentication property.

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

URI Parameters

Name In Required Type Description
authenticationName
 path True

AuthenticationName

The name of server azure active directory only authentication.
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.azureADOnlyAuthentication True

boolean

Azure Active Directory only Authentication enabled.

Responses

Name Type Description
200 OK

ServerAzureADOnlyAuthentication

Successfully updated a Azure Active Directory only authentication property.
201 Created

ServerAzureADOnlyAuthentication

Successfully updated Azure Active Directory only authentication property.
202 Accepted

Accepted

Headers

Location: string
Other Status Codes

ErrorResponse

*** Error Responses: ***

  • 400 InvalidServerAzureADOnlyAuthenticationParameter - User tried to set AzureADOnlyAuthentication parameter to false which is not allowed, please use azureADOnlyAuthentications API instead.

  • 400 InvalidServerAADOnlyAuthTypePropertyName - Server Azure Active Directory only authentication type should be Default

  • 400 InvalidServerAADOnlyAuthNoAADAdminPropertyName - AAD Admin is not configured, AAD Admin must be set before enabling/disabling AAD Only Authentication.

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

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

  • 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 Azure Active Directory only authentication object.

Sample request

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

{
  "properties": {
    "azureADOnlyAuthentication": false
  }
}

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-6440/azureadonlyauthentications/default",
  "name": "Default",
  "type": "Microsoft.Sql/servers/azureadonlyauthentications",
  "properties": {
    "azureADOnlyAuthentication": false
  }
}
Status code:
201 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-4799/providers/Microsoft.Sql/servers/sqlcrudtest-6440/azureadonlyauthentications/default",
  "name": "Default",
  "type": "Microsoft.Sql/servers/azureadonlyauthentications",
  "properties": {
    "azureADOnlyAuthentication": false
  }
}
Status code:
202

Definitions

Name Description
AuthenticationName

The name of server azure active directory only authentication.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
ServerAzureADOnlyAuthentication

Azure Active Directory only authentication.

AuthenticationName

Enumeration

The name of server azure active directory only authentication.

Value Description
Default

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.

ServerAzureADOnlyAuthentication

Object

Azure Active Directory only authentication.

Name Type Description
id

string

Resource ID.
name

string

Resource name.
properties.azureADOnlyAuthentication

boolean

Azure Active Directory only Authentication enabled.
type

string

Resource type.