Subscriptions - List

Service:

Subscription

API Version:

2016-06-01

Gets all subscriptions for a tenant.

GET https://management.azure.com/subscriptions?api-version=2016-06-01

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	The API version to use for the operation.

Responses

Name	Type	Description
200 OK	SubscriptionListResult	OK - Returns an array of subscriptions.

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

listSubscriptions

Sample request

HTTP

GET https://management.azure.com/subscriptions?api-version=2016-06-01

Java

/** Samples for Subscriptions List. */
public final class Main {
    /*
     * x-ms-original-file: specification/subscription/resource-manager/Microsoft.Subscription/stable/2016-06-01/examples/listSubscriptions.json
     */
    /**
     * Sample code: listSubscriptions.
     *
     * @param manager Entry point to SubscriptionManager.
     */
    public static void listSubscriptions(com.azure.resourcemanager.subscription.SubscriptionManager manager) {
        manager.subscriptions().list(com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.subscription import SubscriptionClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-subscription
# USAGE
    python list_subscriptions.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 = SubscriptionClient(
        credential=DefaultAzureCredential(),
    )

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


# x-ms-original-file: specification/subscription/resource-manager/Microsoft.Subscription/stable/2016-06-01/examples/listSubscriptions.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 armsubscription_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/subscription/armsubscription"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/subscription/resource-manager/Microsoft.Subscription/stable/2016-06-01/examples/listSubscriptions.json
func ExampleSubscriptionsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsubscription.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewSubscriptionsClient().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.ListResult = armsubscription.ListResult{
		// 	Value: []*armsubscription.Subscription{
		// 		{
		// 			AuthorizationSource: to.Ptr("Legacy"),
		// 			DisplayName: to.Ptr("SubscriptionName"),
		// 			ID: to.Ptr("/subscriptions/83aa47df-e3e9-49ff-877b-94304bf3d3ad"),
		// 			State: to.Ptr(armsubscription.SubscriptionStateEnabled),
		// 			SubscriptionID: to.Ptr("83aa47df-e3e9-49ff-877b-94304bf3d3ad"),
		// 			SubscriptionPolicies: &armsubscription.Policies{
		// 				LocationPlacementID: to.Ptr("Internal_2014-09-01"),
		// 				QuotaID: to.Ptr("Internal_2014-09-01"),
		// 				SpendingLimit: to.Ptr(armsubscription.SpendingLimitOff),
		// 			},
		// 	}},
		// }
	}
}

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 { SubscriptionClient } = require("@azure/arm-subscriptions");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets all subscriptions for a tenant.
 *
 * @summary Gets all subscriptions for a tenant.
 * x-ms-original-file: specification/subscription/resource-manager/Microsoft.Subscription/stable/2016-06-01/examples/listSubscriptions.json
 */
async function listSubscriptions() {
  const credential = new DefaultAzureCredential();
  const client = new SubscriptionClient(credential);
  const resArray = new Array();
  for await (let item of client.subscriptions.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

listSubscriptions().catch(console.error);

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

{
  "nextLink": "string",
  "value": [
    {
      "id": "/subscriptions/83aa47df-e3e9-49ff-877b-94304bf3d3ad",
      "authorizationSource": "Legacy",
      "subscriptionId": "83aa47df-e3e9-49ff-877b-94304bf3d3ad",
      "displayName": "SubscriptionName",
      "state": "Enabled",
      "subscriptionPolicies": {
        "locationPlacementId": "Internal_2014-09-01",
        "quotaId": "Internal_2014-09-01",
        "spendingLimit": "Off"
      }
    }
  ]
}

Definitions

Name	Description
spendingLimit	The subscription spending limit.
Subscription	Subscription information.
SubscriptionListResult	Subscription list operation response.
SubscriptionPolicies	Subscription policies.
SubscriptionState	The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted.

spendingLimit

The subscription spending limit.

Name	Type	Description
CurrentPeriodOff	string
Off	string
On	string

Subscription

Subscription information.

Name	Type	Description
authorizationSource	string	The authorization source of the request. Valid values are one or more combinations of Legacy, RoleBased, Bypassed, Direct and Management. For example, 'Legacy, RoleBased'.
displayName	string	The subscription display name.
id	string	The fully qualified ID for the subscription. For example, /subscriptions/00000000-0000-0000-0000-000000000000.
state	SubscriptionState	The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted.
subscriptionId	string	The subscription ID.
subscriptionPolicies	SubscriptionPolicies	The subscription policies.
tags	object	Tags for the subscription
tenantId	string	The tenant ID. For example, 00000000-0000-0000-0000-000000000000.

SubscriptionListResult

Subscription list operation response.

Name	Type	Description
nextLink	string	The URL to get the next set of results.
value	Subscription[]	An array of subscriptions.

SubscriptionPolicies

Subscription policies.

Name	Type	Description
locationPlacementId	string	The subscription location placement ID. The ID indicates which regions are visible for a subscription. For example, a subscription with a location placement Id of Public_2014-09-01 has access to Azure public regions.
quotaId	string	The subscription quota ID.
spendingLimit	spendingLimit	The subscription spending limit.

SubscriptionState

The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted.

Name	Type	Description
Deleted	string
Disabled	string
Enabled	string
PastDue	string
Warned	string