Managed Instance Administrators - Get

Service:: SQL Database

API Version:: 2023-08-01

Gets a managed instance administrator.

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

URI Parameters

Name	In	Required	Type	Description
administratorName	path	True	AdministratorName
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	ManagedInstanceAdministrator	Successfully retrieved the the specified managed instance administrator.
Other Status Codes	ErrorResponse	* Error Responses: * 400 SubnetMissingRequiredDelegation - Selected subnet is not delegated for SQL Managed Instance. 400 InvalidManagedServerAdministratorType - Invalid administrator type specified in properties. 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid. 400 InvalidManagedServerAzureADAdminDeleteOperation - User tried to delete managed server Azure Active Azure admin when AzureADOnlyAuthentication is set, please use azureADOnlyAuthentications API first. 400 InvalidManagedServerAADOnlyAuthTypePropertyName - Managed Server Azure Active Directory only authentication type should be Default 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

ManagedInstanceAdministrator

Successfully retrieved the the specified managed instance administrator.

Other Status Codes

ErrorResponse

*** Error Responses: ***

400 SubnetMissingRequiredDelegation - Selected subnet is not delegated for SQL Managed Instance.
400 InvalidManagedServerAdministratorType - Invalid administrator type specified in properties.
400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.
400 InvalidManagedServerAzureADAdminDeleteOperation - User tried to delete managed server Azure Active Azure admin when AzureADOnlyAuthentication is set, please use azureADOnlyAuthentications API first.
400 InvalidManagedServerAADOnlyAuthTypePropertyName - Managed Server Azure Active Directory only authentication type should be Default
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

Get administrator of managed instance

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/managedInstance/administrators/ActiveDirectory?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/ManagedInstanceAdministratorGet.json
// this example is just showing the usage of "ManagedInstanceAdministrators_Get" 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 ManagedInstanceAdministratorResource created on azure
// for more information of creating ManagedInstanceAdministratorResource, please refer to the document of ManagedInstanceAdministratorResource
string subscriptionId = "00000000-1111-2222-3333-444444444444";
string resourceGroupName = "Default-SQL-SouthEastAsia";
string managedInstanceName = "managedInstance";
SqlAdministratorName administratorName = SqlAdministratorName.ActiveDirectory;
ResourceIdentifier managedInstanceAdministratorResourceId = ManagedInstanceAdministratorResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, managedInstanceName, administratorName);
ManagedInstanceAdministratorResource managedInstanceAdministrator = client.GetManagedInstanceAdministratorResource(managedInstanceAdministratorResourceId);

// invoke the operation
ManagedInstanceAdministratorResource result = await managedInstanceAdministrator.GetAsync();

// the variable result 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
ManagedInstanceAdministratorData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/managedInstance/administrators/ActiveDirectory",
  "name": "ActiveDirectory",
  "properties": {
    "administratorType": "ActiveDirectory",
    "login": "bob@contoso.com",
    "sid": "44444444-3333-2222-1111-000000000000",
    "tenantId": "55555555-4444-3333-2222-111111111111"
  },
  "type": "Microsoft.Sql/managedInstances/administrators"
}

Definitions

Name	Description
AdministratorName
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ManagedInstanceAdministrator	An Azure SQL managed instance administrator.
ManagedInstanceAdministratorType	Type of the managed instance administrator.

AdministratorName

Enumeration

Value	Description
ActiveDirectory

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.

ManagedInstanceAdministrator

Object

An Azure SQL managed instance administrator.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.administratorType	ManagedInstanceAdministratorType	Type of the managed instance administrator.
properties.login	string	Login name of the managed instance administrator.
properties.sid	string (uuid)	SID (object ID) of the managed instance administrator.
properties.tenantId	string (uuid)	Tenant ID of the managed instance administrator.
type	string	Resource type.

ManagedInstanceAdministratorType

Enumeration

Type of the managed instance administrator.

Value	Description
ActiveDirectory

Share via

Managed Instance Administrators - Get

URI Parameters

Responses

Examples

Get administrator of managed instance

Sample request

Sample response

Definitions

AdministratorName

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ManagedInstanceAdministrator

ManagedInstanceAdministratorType