Managed Instance Azure AD Only Authentications - Get

Gets a specific Azure Active Directory only authentication property.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/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.

managedInstanceName
path True

string

The name of the managed instance.

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.

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

ManagedInstanceAzureADOnlyAuthentication

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 InvalidManagedServerAADOnlyAuthTypePropertyName - Managed Server Azure Active Directory only authentication type should be Default

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

  • 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.

  • 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.

  • 404 SubscriptionNotFound - The requested subscription was not found.

  • 404 ResourceNotFound - The requested resource was not found.

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

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

  • 504 RequestTimeout - Service request exceeded the allowed timeout.

Examples

Gets a Azure Active Directory only authentication property.

Sample request

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/managedInstance/azureADOnlyAuthentications/Default?api-version=2021-11-01

Sample response

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/azureADOnlyAuthentications/providers/Microsoft.Sql/managedInstances/managedInstance/azureadonlyauthentications/default",
  "name": "Default",
  "type": "Microsoft.Sql/managedInstances/azureadonlyauthentications",
  "properties": {
    "azureADOnlyAuthentication": true
  }
}

Definitions

Name Description
AuthenticationName

The name of server azure active directory only authentication.

ManagedInstanceAzureADOnlyAuthentication

Azure Active Directory only authentication.

AuthenticationName

The name of server azure active directory only authentication.

Name Type Description
Default

string

ManagedInstanceAzureADOnlyAuthentication

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.