Managed Instance Azure AD Only Authentications - List By Instance

Service:: SQL Database

API Version:: 2023-08-01

Gets a list of server Azure Active Directory only authentications.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/azureADOnlyAuthentications?api-version=2023-08-01

URI Parameters

Name	In	Required	Type	Description
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	ManagedInstanceAzureADOnlyAuthListResult	Successfully retrieved the list of Azure Active Directory only authentication objects.
Other Status Codes	ErrorResponse	* Error Responses: * 400 SubnetMissingRequiredDelegation - Selected subnet is not delegated for SQL Managed Instance. 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription. 404 SubscriptionNotFound - The requested subscription was not found. 404 ServerNotInSubscription - Specified server does not exist on the specified subscription. 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.

Name

Type

Description

200 OK

ManagedInstanceAzureADOnlyAuthListResult

Successfully retrieved the list of Azure Active Directory only authentication objects.

Other Status Codes

ErrorResponse

*** Error Responses: ***

400 SubnetMissingRequiredDelegation - Selected subnet is not delegated for SQL Managed Instance.
404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.
404 SubscriptionNotFound - The requested subscription was not found.
404 ServerNotInSubscription - Specified server does not exist on the specified subscription.
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 list of Azure Active Directory only authentication object.

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Sql.Models;
using Azure.ResourceManager.Sql;

// Generated from example definition: specification/sql/resource-manager/Microsoft.Sql/stable/2023-08-01/examples/ManagedInstanceAzureADOnlyAuthListByInstance.json
// this example is just showing the usage of "ManagedInstanceAzureADOnlyAuthentications_ListByInstance" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://free.blessedness.top/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ManagedInstanceResource created on azure
// for more information of creating ManagedInstanceResource, please refer to the document of ManagedInstanceResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string managedInstanceName = "managedInstance";
ResourceIdentifier managedInstanceResourceId = ManagedInstanceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName);
ManagedInstanceResource managedInstance = client.GetManagedInstanceResource(managedInstanceResourceId);

// get the collection of this ManagedInstanceAzureADOnlyAuthenticationResource
ManagedInstanceAzureADOnlyAuthenticationCollection collection = managedInstance.GetManagedInstanceAzureADOnlyAuthentications();

// invoke the operation and iterate over the result
await foreach (ManagedInstanceAzureADOnlyAuthenticationResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ManagedInstanceAzureADOnlyAuthenticationData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

{
  "value": [
    {
      "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
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ManagedInstanceAzureADOnlyAuthentication	Azure Active Directory only authentication.
ManagedInstanceAzureADOnlyAuthListResult	A list of active directory only authentications.

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.

ManagedInstanceAzureADOnlyAuthentication

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.

ManagedInstanceAzureADOnlyAuthListResult

Object

A list of active directory only authentications.

Name	Type	Description
nextLink	string	Link to retrieve next page of results.
value	ManagedInstanceAzureADOnlyAuthentication[]	Array of results.

Share via

Managed Instance Azure AD Only Authentications - List By Instance

URI Parameters

Responses

Examples

Gets a list of Azure Active Directory only authentication object.

Sample request

Sample response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedInstanceAzureADOnlyAuthentication

ManagedInstanceAzureADOnlyAuthListResult