Subscriptions - List

Referência

Serviço:: Resource Management

Versão da API:: 2022-12-01

Obtém todas as subscrições de um inquilino.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
api-version	query	True	string	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Description
200 OK	SubscriptionListResult	OK - Devolve uma matriz de subscrições.
Other Status Codes	CloudError	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

GetAllSubscriptions

Pedido de amostra

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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
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

Resposta da amostra

Código de estado:: 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": "..."
}

Definições

Name	Description
CloudError	Uma resposta de erro para um pedido de gestão de recursos.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
ManagedByTenant	Informações sobre um inquilino que gere a subscrição.
spendingLimit	O limite de gastos da subscrição.
Subscription	Informações da subscrição.
SubscriptionListResult	Resposta da operação da lista de subscrições.
SubscriptionPolicies	Políticas de subscrição.
SubscriptionState	O estado da subscrição. Os valores possíveis são Ativado, Avisado, Vencido, Desativado e Eliminado.

CloudError

Uma resposta de erro para um pedido de gestão de recursos.

Name	Tipo	Description
error	ErrorResponse	Resposta a erros Resposta de erro comum para todas as APIs do Azure Resource Manager para devolver detalhes do erro para operações com falhas. (Isto também segue o formato de resposta de erro OData.).

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ManagedByTenant

Informações sobre um inquilino que gere a subscrição.

Name	Tipo	Description
tenantId	string	O ID de inquilino do inquilino de gestão. Este é um GUID.

spendingLimit

O limite de gastos da subscrição.

Name	Tipo	Description
CurrentPeriodOff	string
Off	string
On	string

Subscription

Informações da subscrição.

Name	Tipo	Description
authorizationSource	string	A origem de autorização do pedido. Os valores válidos são uma ou mais combinações de Legado, RoleBased, Bypassed, Direct e Management. Por exemplo, "Legado, RoleBased".
displayName	string	O nome a apresentar da subscrição.
id	string	O ID completamente qualificado da subscrição. Por exemplo, /subscriptions/8d65815f-a5b6-402f-9298-045155da7d74
managedByTenants	ManagedByTenant[]	Uma matriz que contém os inquilinos que gerem a subscrição.
state	SubscriptionState	O estado da subscrição. Os valores possíveis são Ativado, Avisado, Vencido, Desativado e Eliminado.
subscriptionId	string	O ID da subscrição.
subscriptionPolicies	SubscriptionPolicies	As políticas de subscrição.
tags	object	As etiquetas anexadas à subscrição.
tenantId	string	O ID do inquilino da subscrição.

SubscriptionListResult

Resposta da operação da lista de subscrições.

Name	Tipo	Description
nextLink	string	O URL para obter o próximo conjunto de resultados.
value	Subscription[]	Uma matriz de subscrições.

SubscriptionPolicies

Políticas de subscrição.

Name	Tipo	Description
locationPlacementId	string	O ID de colocação da localização da subscrição. O ID indica que regiões estão visíveis para uma subscrição. Por exemplo, uma subscrição com um ID de colocação de localização do Public_2014-09-01 tem acesso às regiões públicas do Azure.
quotaId	string	O ID de quota da subscrição.
spendingLimit	spendingLimit	O limite de gastos da subscrição.

SubscriptionState

O estado da subscrição. Os valores possíveis são Ativado, Avisado, Vencido, Desativado e Eliminado.

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