Subscriptions - List

Referencia

Service:: Resource Management

API Version:: 2022-12-01

Obtiene todas las suscripciones de un inquilino.

GET https://management.azure.com/subscriptions?api-version=2022-12-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
api-version	query	True	string	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	SubscriptionListResult	Aceptar: devuelve una matriz de suscripciones.
Other Status Codes	CloudError	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

GetAllSubscriptions

Sample Request

GET https://management.azure.com/subscriptions?api-version=2022-12-01


/** Samples for Subscriptions List. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscriptions.json
     */
    /**
     * Sample code: GetAllSubscriptions.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getAllSubscriptions(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.genericResources().manager().subscriptionClient().getSubscriptions()
            .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

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource import SubscriptionClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource
# USAGE
    python get_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/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscriptions.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

package armsubscriptions_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armsubscriptions"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4f4073bdb028bc84bc3e6405c1cbaf8e89b83caf/specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscriptions.json
func ExampleClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsubscriptions.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewClient().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.SubscriptionListResult = armsubscriptions.SubscriptionListResult{
		// 	Value: []*armsubscriptions.Subscription{
		// 		{
		// 			AuthorizationSource: to.Ptr("RoleBased"),
		// 			DisplayName: to.Ptr("Example Subscription"),
		// 			ID: to.Ptr("/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05"),
		// 			ManagedByTenants: []*armsubscriptions.ManagedByTenant{
		// 				{
		// 					TenantID: to.Ptr("8f70baf1-1f6e-46a2-a1ff-238dac1ebfb7"),
		// 			}},
		// 			State: to.Ptr(armsubscriptions.SubscriptionStateEnabled),
		// 			SubscriptionID: to.Ptr("291bba3f-e0a5-47bc-a099-3bdcb2a50a05"),
		// 			SubscriptionPolicies: &armsubscriptions.SubscriptionPolicies{
		// 				LocationPlacementID: to.Ptr("Internal_2014-09-01"),
		// 				QuotaID: to.Ptr("Internal_2014-09-01"),
		// 				SpendingLimit: to.Ptr(armsubscriptions.SpendingLimitOff),
		// 			},
		// 			Tags: map[string]*string{
		// 				"tagKey1": to.Ptr("tagValue1"),
		// 				"tagKey2": to.Ptr("tagValue2"),
		// 			},
		// 			TenantID: to.Ptr("31c75423-32d6-4322-88b7-c478bdde4858"),
		// 		},
		// 		{
		// 			AuthorizationSource: to.Ptr("RoleBased"),
		// 			DisplayName: to.Ptr("Example Subscription2"),
		// 			ID: to.Ptr("/subscriptions/72ac930a-f34e-42d8-b06d-dc2a9e12ed71"),
		// 			ManagedByTenants: []*armsubscriptions.ManagedByTenant{
		// 				{
		// 					TenantID: to.Ptr("8f70baf1-1f6e-46a2-a1ff-238dac1ebfb7"),
		// 				},
		// 				{
		// 					TenantID: to.Ptr("f7fb6af2-321d-47c8-9c0f-b0239eaad39a"),
		// 			}},
		// 			State: to.Ptr(armsubscriptions.SubscriptionStateEnabled),
		// 			SubscriptionID: to.Ptr("72ac930a-f34e-42d8-b06d-dc2a9e12ed71"),
		// 			SubscriptionPolicies: &armsubscriptions.SubscriptionPolicies{
		// 				LocationPlacementID: to.Ptr("Internal_2014-09-01"),
		// 				QuotaID: to.Ptr("Internal_2014-09-01"),
		// 				SpendingLimit: to.Ptr(armsubscriptions.SpendingLimitOff),
		// 			},
		// 			Tags: map[string]*string{
		// 				"tagKey1": to.Ptr("tagValue1"),
		// 				"tagKey2": to.Ptr("tagValue2"),
		// 			},
		// 			TenantID: to.Ptr("2a0ff0de-96b2-4859-bb7c-a430d07a3e0c"),
		// 	}},
		// }
	}
}

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

const { SubscriptionClient } = require("@azure/arm-resources-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/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscriptions.json
 */
async function getAllSubscriptions() {
  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);
}

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

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/resources/resource-manager/Microsoft.Resources/stable/2022-12-01/examples/GetSubscriptions.json
// this example is just showing the usage of "Subscriptions_List" 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://learn.microsoft.com/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 TenantResource created on azure
// for more information of creating TenantResource, please refer to the document of TenantResource
var tenant = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// get the collection of this SubscriptionResource
SubscriptionCollection collection = tenant.GetSubscriptions();

// invoke the operation and iterate over the result
await foreach (SubscriptionResource 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
    SubscriptionData 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/291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
      "subscriptionId": "291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
      "tenantId": "31c75423-32d6-4322-88b7-c478bdde4858",
      "displayName": "Example Subscription",
      "state": "Enabled",
      "subscriptionPolicies": {
        "locationPlacementId": "Internal_2014-09-01",
        "quotaId": "Internal_2014-09-01",
        "spendingLimit": "Off"
      },
      "authorizationSource": "RoleBased",
      "managedByTenants": [
        {
          "tenantId": "8f70baf1-1f6e-46a2-a1ff-238dac1ebfb7"
        }
      ],
      "tags": {
        "tagKey1": "tagValue1",
        "tagKey2": "tagValue2"
      }
    },
    {
      "id": "/subscriptions/72ac930a-f34e-42d8-b06d-dc2a9e12ed71",
      "subscriptionId": "72ac930a-f34e-42d8-b06d-dc2a9e12ed71",
      "tenantId": "2a0ff0de-96b2-4859-bb7c-a430d07a3e0c",
      "displayName": "Example Subscription2",
      "state": "Enabled",
      "subscriptionPolicies": {
        "locationPlacementId": "Internal_2014-09-01",
        "quotaId": "Internal_2014-09-01",
        "spendingLimit": "Off"
      },
      "authorizationSource": "RoleBased",
      "managedByTenants": [
        {
          "tenantId": "8f70baf1-1f6e-46a2-a1ff-238dac1ebfb7"
        },
        {
          "tenantId": "f7fb6af2-321d-47c8-9c0f-b0239eaad39a"
        }
      ],
      "tags": {
        "tagKey1": "tagValue1",
        "tagKey2": "tagValue2"
      }
    }
  ],
  "nextLink": "..."
}

Definiciones

Nombre	Description
CloudError	Una respuesta de error para una solicitud de administración de recursos.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ManagedByTenant	Información sobre un inquilino que administra la suscripción.
spendingLimit	Límite de gasto de la suscripción.
Subscription	Información de suscripción.
SubscriptionListResult	Respuesta de operación de lista de suscripción.
SubscriptionPolicies	Directivas de suscripción.
SubscriptionState	Estado de la suscripción. Los valores posibles son Enabled, Warned, PastDue, Disabled y Deleted.

CloudError

Una respuesta de error para una solicitud de administración de recursos.

Nombre	Tipo	Description
error	ErrorResponse	Respuesta de error Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ManagedByTenant

Información sobre un inquilino que administra la suscripción.

Nombre	Tipo	Description
tenantId	string	Identificador de inquilino del inquilino de administración. Este identificador es un GUID.

spendingLimit

Límite de gasto de la suscripción.

Nombre	Tipo	Description
CurrentPeriodOff	string
Off	string
On	string

Subscription

Información de suscripción.

Nombre	Tipo	Description
authorizationSource	string	Origen de autorización de la solicitud. Los valores válidos son una o varias combinaciones de Legacy, RoleBased, Bypassed, Direct y Management. Por ejemplo, "Legacy, RoleBased".
displayName	string	Nombre para mostrar de la suscripción.
id	string	Identificador completo de la suscripción. Por ejemplo, /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74
managedByTenants	ManagedByTenant[]	Matriz que contiene los inquilinos que administran la suscripción.
state	SubscriptionState	Estado de la suscripción. Los valores posibles son Enabled, Warned, PastDue, Disabled y Deleted.
subscriptionId	string	Identificador de la suscripción.
subscriptionPolicies	SubscriptionPolicies	Las directivas de suscripción.
tags	object	Etiquetas adjuntas a la suscripción.
tenantId	string	Identificador de inquilino de la suscripción.

SubscriptionListResult

Respuesta de operación de lista de suscripción.

Nombre	Tipo	Description
nextLink	string	Dirección URL para obtener el siguiente conjunto de resultados.
value	Subscription[]	Matriz de suscripciones.

SubscriptionPolicies

Directivas de suscripción.

Nombre	Tipo	Description
locationPlacementId	string	Identificador de ubicación de ubicación de la suscripción. El identificador indica qué regiones están visibles para una suscripción. Por ejemplo, una suscripción con un identificador de ubicación de ubicación de Public_2014-09-01 tiene acceso a las regiones públicas de Azure.
quotaId	string	Identificador de cuota de la suscripción.
spendingLimit	spendingLimit	Límite de gasto de la suscripción.

SubscriptionState

Estado de la suscripción. Los valores posibles son Enabled, Warned, PastDue, Disabled y Deleted.

Nombre	Tipo	Description
Deleted	string
Disabled	string
Enabled	string
PastDue	string
Warned	string