Subscriptions - List

サービス:: Resource Management

API バージョン:: 2022-12-01

テナントのすべてのサブスクリプションを取得します。

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

URI パラメーター

名前	/	必須	型	説明
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	SubscriptionListResult	Azureの運用は無事に完了しました。
Other Status Codes	CloudError	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

GetAllSubscriptions

要求のサンプル

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource.subscriptions import SubscriptionClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource-subscriptions
# 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: 2022-12-01/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/v2"
)

// Generated from example definition: 2022-12-01/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 = armsubscriptions.ClientListResponse{
		// 	SubscriptionListResult: armsubscriptions.SubscriptionListResult{
		// 		NextLink: to.Ptr("http://nextlink"),
		// 		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: 2022-12-01/GetSubscriptions.json
 */
async function getAllSubscriptions() {
  const credential = new DefaultAzureCredential();
  const client = new SubscriptionClient(credential);
  const resArray = new Array();
  for await (const 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

応答のサンプル

状態コード:: 200

{
  "nextLink": "http://nextlink",
  "value": [
    {
      "authorizationSource": "RoleBased",
      "displayName": "Example Subscription",
      "id": "/subscriptions/291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
      "managedByTenants": [
        {
          "tenantId": "8f70baf1-1f6e-46a2-a1ff-238dac1ebfb7"
        }
      ],
      "state": "Enabled",
      "subscriptionId": "291bba3f-e0a5-47bc-a099-3bdcb2a50a05",
      "subscriptionPolicies": {
        "locationPlacementId": "Internal_2014-09-01",
        "quotaId": "Internal_2014-09-01",
        "spendingLimit": "Off"
      },
      "tags": {
        "tagKey1": "tagValue1",
        "tagKey2": "tagValue2"
      },
      "tenantId": "31c75423-32d6-4322-88b7-c478bdde4858"
    },
    {
      "authorizationSource": "RoleBased",
      "displayName": "Example Subscription2",
      "id": "/subscriptions/72ac930a-f34e-42d8-b06d-dc2a9e12ed71",
      "managedByTenants": [
        {
          "tenantId": "8f70baf1-1f6e-46a2-a1ff-238dac1ebfb7"
        },
        {
          "tenantId": "f7fb6af2-321d-47c8-9c0f-b0239eaad39a"
        }
      ],
      "state": "Enabled",
      "subscriptionId": "72ac930a-f34e-42d8-b06d-dc2a9e12ed71",
      "subscriptionPolicies": {
        "locationPlacementId": "Internal_2014-09-01",
        "quotaId": "Internal_2014-09-01",
        "spendingLimit": "Off"
      },
      "tags": {
        "tagKey1": "tagValue1",
        "tagKey2": "tagValue2"
      },
      "tenantId": "2a0ff0de-96b2-4859-bb7c-a430d07a3e0c"
    }
  ]
}

定義

名前	説明
CloudError	リソース管理要求のエラー応答。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ManagedByTenant	サブスクリプションを管理しているテナントに関する情報。
SpendingLimit	サブスクリプションの使用制限。
Subscription	サブスクリプション情報。
SubscriptionListResult	サブスクリプションリスト操作の応答。
SubscriptionPolicies	サブスクリプションポリシー。
SubscriptionState	サブスクリプションの状態。使用可能な値は、Enabled、Warned、PastDue、Disabled、Deleted です。

CloudError

Object

リソース管理要求のエラー応答。

名前	型	説明
error	ErrorResponse	エラー応答失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

ManagedByTenant

Object

サブスクリプションを管理しているテナントに関する情報。

名前	型	説明
tenantId	string	管理しているテナントのテナント ID。これは GUID です。

SpendingLimit

列挙

サブスクリプションの使用制限。

値	説明
On	オン
Off	オフ
CurrentPeriodOff	現在の期間停止

Subscription

Object

サブスクリプション情報。

名前	型	説明
authorizationSource	string	要求の承認ソース。有効な値は、レガシ、RoleBased、Bypassed、Direct、Management の 1 つ以上の組み合わせです。たとえば、"レガシ、RoleBased" などです。
displayName	string	サブスクリプションの表示名。
id	string	サブスクリプションの完全修飾 ID。たとえば、/subscriptions/8d65815f-a5b6-402f-9298-045155da7d74
managedByTenants	ManagedByTenant[]	サブスクリプションを管理しているテナントを含む配列。
state	SubscriptionState	サブスクリプションの状態。使用可能な値は、Enabled、Warned、PastDue、Disabled、Deleted です。
subscriptionId	string	サブスクリプション ID。
subscriptionPolicies	SubscriptionPolicies	サブスクリプションポリシー。
tags	object	サブスクリプションにアタッチされているタグ。
tenantId	string	サブスクリプションテナント ID。

SubscriptionListResult

Object

サブスクリプションリスト操作の応答。

名前	型	説明
nextLink	string (uri)	アイテムの次のページへのリンク
value	Subscription[]	このページの購読項目

SubscriptionPolicies

Object

サブスクリプションポリシー。

名前	型	説明
locationPlacementId	string	サブスクリプションの場所の配置 ID。この ID は、サブスクリプションに対して表示されるリージョンを示します。たとえば、Public_2014-09-01 の場所配置 ID を持つサブスクリプションは、Azure パブリックリージョンにアクセスできます。
quotaId	string	サブスクリプションクォータ ID。
spendingLimit	SpendingLimit	サブスクリプションの使用制限。

SubscriptionState

列挙

サブスクリプションの状態。使用可能な値は、Enabled、Warned、PastDue、Disabled、Deleted です。

値	説明
Enabled	有効
Warned	警告
PastDue	卒業予定
Disabled	Disabled
Deleted	削除済み