Classic Administrators - List

Service:

Authorization

API Version:

2015-07-01

Gets service administrator, account administrator, and co-administrators for the subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/classicAdministrators?api-version=2015-07-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ClassicAdministratorListResult	Returns an array of administrators.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Permissions

To call this API, you must be assigned a role that has the following permissions. For more information, see Azure built-in roles.

Microsoft.Authorization/classicAdministrators/read

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List classic administrators

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Authorization/classicAdministrators?api-version=2015-07-01

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.authorization import AuthorizationManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-authorization
# USAGE
    python get_classic_administrators.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = AuthorizationManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.classic_administrators.list()
    for item in response:
        print(item)


# x-ms-original-file: 2015-07-01/GetClassicAdministrators.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armauthorization_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization/v3"
)

// Generated from example definition: 2015-07-01/GetClassicAdministrators.json
func ExampleClassicAdministratorsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armauthorization.NewClientFactory("subId", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewClassicAdministratorsClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armauthorization.ClassicAdministratorsClientListResponse{
		// 	ClassicAdministratorListResult: armauthorization.ClassicAdministratorListResult{
		// 		Value: []*armauthorization.ClassicAdministrator{
		// 			{
		// 				Name: to.Ptr("classicadminid"),
		// 				Type: to.Ptr("Microsoft.Authorization/classicAdministrators"),
		// 				ID: to.Ptr("/subscriptions/subId/providers/Microsoft.Authorization/classicAdministrators/classicadminid"),
		// 				Properties: &armauthorization.ClassicAdministratorProperties{
		// 					EmailAddress: to.Ptr("test@test.com"),
		// 					Role: to.Ptr("ServiceAdministrator;AccountAdministrator"),
		// 				},
		// 			},
		// 			{
		// 				Name: to.Ptr("classicadminid2"),
		// 				Type: to.Ptr("Microsoft.Authorization/classicAdministrators"),
		// 				ID: to.Ptr("/subscriptions/subId/providers/Microsoft.Authorization/classicAdministrators/classicadminid2"),
		// 				Properties: &armauthorization.ClassicAdministratorProperties{
		// 					EmailAddress: to.Ptr("coadmin@test.com"),
		// 					Role: to.Ptr("CoAdministrator"),
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { AuthorizationManagementClient } = require("@azure/arm-authorization");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to gets service administrator, account administrator, and co-administrators for the subscription.
 *
 * @summary gets service administrator, account administrator, and co-administrators for the subscription.
 * x-ms-original-file: 2015-07-01/GetClassicAdministrators.json
 */
async function listClassicAdministrators() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "subId";
  const client = new AuthorizationManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.classicAdministrators.list()) {
    resArray.push(item);
  }

  console.log(resArray);
}

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": [
    {
      "name": "classicadminid",
      "type": "Microsoft.Authorization/classicAdministrators",
      "id": "/subscriptions/subId/providers/Microsoft.Authorization/classicAdministrators/classicadminid",
      "properties": {
        "emailAddress": "test@test.com",
        "role": "ServiceAdministrator;AccountAdministrator"
      }
    },
    {
      "name": "classicadminid2",
      "type": "Microsoft.Authorization/classicAdministrators",
      "id": "/subscriptions/subId/providers/Microsoft.Authorization/classicAdministrators/classicadminid2",
      "properties": {
        "emailAddress": "coadmin@test.com",
        "role": "CoAdministrator"
      }
    }
  ]
}

Definitions

Name	Description
ClassicAdministrator	Classic Administrators
ClassicAdministratorListResult	ClassicAdministrator list result information.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

ClassicAdministrator

Object

Classic Administrators

Name	Type	Description
id	string	The ID of the administrator.
name	string	The name of the administrator.
properties.emailAddress	string	The email address of the administrator.
properties.role	string	The role of the administrator.
type	string	The type of the administrator.

ClassicAdministratorListResult

Object

ClassicAdministrator list result information.

Name	Type	Description
nextLink	string	The URL to use for getting the next set of results.
value	ClassicAdministrator[]	An array of administrators.

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.