Server Azure AD Only Authentications - Get

Service:

SQL Database

API Version:

2021-11-01

Gets a specific Azure Active Directory only authentication property.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/azureADOnlyAuthentications/Default?api-version=2021-11-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.

Responses

Name	Type	Description
200 OK	ServerAzureADOnlyAuthentication	Successfully retrieved a specified Azure Active Directory only authentication properties.
Other Status Codes		*** 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. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription. 404 ResourceNotFound - The requested resource was not found.

Examples

Gets a Azure Active Directory only authentication property.

Sample Request

HTTP

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

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.models.AuthenticationName;

/** Samples for ServerAzureADOnlyAuthentications Get. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/AzureADOnlyAuthGet.json
     */
    /**
     * Sample code: Gets a Azure Active Directory only authentication property.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        getsAAzureActiveDirectoryOnlyAuthenticationProperty(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getServerAzureADOnlyAuthentications()
            .getWithResponse("sqlcrudtest-4799", "sqlcrudtest-6440", AuthenticationName.DEFAULT, 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/azureadonlyauthentications/default",
  "name": "Default",
  "type": "Microsoft.Sql/servers/azureadonlyauthentications",
  "properties": {
    "azureADOnlyAuthentication": true
  }
}

Definitions

Name	Description
AuthenticationName	The name of server azure active directory only authentication.
ServerAzureADOnlyAuthentication	Azure Active Directory only authentication.

AuthenticationName

The name of server azure active directory only authentication.

Name	Type	Description
Default	string

ServerAzureADOnlyAuthentication

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.