Managed Instance Administrators - List By Instance

  • Reference
Service:
SQL Database
API Version:
2021-11-01

Gets a list of managed instance administrators.

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

ManagedInstanceAdministratorListResult

Successfully retrieved the list of managed instance administrators.
Other Status Codes

*** Error Responses: ***

  • 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

List administrators of managed instance

Sample request

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

Sample response

Status code:
200 
{
  "value": [
    {
      "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
ManagedInstanceAdministrator

An Azure SQL managed instance administrator.
ManagedInstanceAdministratorListResult

A list of managed instance administrators.
ManagedInstanceAdministratorType

Type of the managed instance administrator.

ManagedInstanceAdministrator

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

SID (object ID) of the managed instance administrator.
properties.tenantId

string

Tenant ID of the managed instance administrator.
type

string

Resource type.

ManagedInstanceAdministratorListResult

A list of managed instance administrators.

Name Type Description
nextLink

string

Link to retrieve next page of results.
value

ManagedInstanceAdministrator[]

Array of results.

ManagedInstanceAdministratorType

Type of the managed instance administrator.

Name Type Description
ActiveDirectory

string