Tenants - List

サービス:: Resource Management

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

アカウントのテナントを取得します。

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

URI パラメーター

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

応答

名前	型	説明
200 OK	TenantListResult	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	ユーザーアカウントを偽装する

例

GetAllTenants

要求のサンプル

GET https://management.azure.com/tenants?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_tenants.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.tenants.list()
    for item in response:
        print(item)


# x-ms-original-file: 2022-12-01/GetTenants.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/GetTenants.json
func ExampleTenantsClient_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.NewTenantsClient().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.TenantsClientListResponse{
		// 	TenantListResult: armsubscriptions.TenantListResult{
		// 		NextLink: to.Ptr("http://nextlink"),
		// 		Value: []*armsubscriptions.TenantIDDescription{
		// 			{
		// 				CountryCode: to.Ptr("US"),
		// 				DefaultDomain: to.Ptr("aad50.ccsctp.net"),
		// 				DisplayName: to.Ptr("Test_Test_aad50"),
		// 				Domains: []*string{
		// 					to.Ptr("aad50.ccsctp.net"),
		// 				},
		// 				ID: to.Ptr("/tenants/a70a1586-9c4a-4373-b907-1d310660dbd1"),
		// 				TenantCategory: to.Ptr(armsubscriptions.TenantCategoryManagedBy),
		// 				TenantID: to.Ptr("a70a1586-9c4a-4373-b907-1d310660dbd1"),
		// 				TenantType: to.Ptr("AAD"),
		// 			},
		// 			{
		// 				CountryCode: to.Ptr("US"),
		// 				DefaultDomain: to.Ptr("auxteststagemanual.ccsctp.net"),
		// 				DisplayName: to.Ptr("Contoso Corp."),
		// 				Domains: []*string{
		// 					to.Ptr("auxteststagemanual.ccsctp.net"),
		// 				},
		// 				ID: to.Ptr("/tenants/83abe5cd-bcc3-441a-bd86-e6a75360cecc"),
		// 				TenantCategory: to.Ptr(armsubscriptions.TenantCategoryHome),
		// 				TenantID: to.Ptr("83abe5cd-bcc3-441a-bd86-e6a75360cecc"),
		// 				TenantType: to.Ptr("AAD"),
		// 			},
		// 			{
		// 				CountryCode: to.Ptr("US"),
		// 				DefaultDomain: to.Ptr("rdvmohoro.ccsctp.net"),
		// 				DisplayName: to.Ptr("TEST_TEST_RDV"),
		// 				Domains: []*string{
		// 					to.Ptr("rdvmohoro.ccsctp.net"),
		// 					to.Ptr("rdvmohoro.mail.ccsctp.net"),
		// 					to.Ptr("rdvmohoro.com"),
		// 				},
		// 				ID: to.Ptr("/tenants/daea2e9b-847b-4c93-850d-2aa6f2d7af33"),
		// 				TenantBrandingLogoURL: to.Ptr("logo1.logo.rdvmohoro.com"),
		// 				TenantCategory: to.Ptr(armsubscriptions.TenantCategoryProjectedBy),
		// 				TenantID: to.Ptr("daea2e9b-847b-4c93-850d-2aa6f2d7af33"),
		// 				TenantType: to.Ptr("AAD"),
		// 			},
		// 		},
		// 	},
		// }
	}
}

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 the tenants for your account.
 *
 * @summary gets the tenants for your account.
 * x-ms-original-file: 2022-12-01/GetTenants.json
 */
async function getAllTenants() {
  const credential = new DefaultAzureCredential();
  const client = new SubscriptionClient(credential);
  const resArray = new Array();
  for await (const item of client.tenants.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": [
    {
      "countryCode": "US",
      "defaultDomain": "aad50.ccsctp.net",
      "displayName": "Test_Test_aad50",
      "domains": [
        "aad50.ccsctp.net"
      ],
      "id": "/tenants/a70a1586-9c4a-4373-b907-1d310660dbd1",
      "tenantCategory": "ManagedBy",
      "tenantId": "a70a1586-9c4a-4373-b907-1d310660dbd1",
      "tenantType": "AAD"
    },
    {
      "countryCode": "US",
      "defaultDomain": "auxteststagemanual.ccsctp.net",
      "displayName": "Contoso Corp.",
      "domains": [
        "auxteststagemanual.ccsctp.net"
      ],
      "id": "/tenants/83abe5cd-bcc3-441a-bd86-e6a75360cecc",
      "tenantCategory": "Home",
      "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc",
      "tenantType": "AAD"
    },
    {
      "countryCode": "US",
      "defaultDomain": "rdvmohoro.ccsctp.net",
      "displayName": "TEST_TEST_RDV",
      "domains": [
        "rdvmohoro.ccsctp.net",
        "rdvmohoro.mail.ccsctp.net",
        "rdvmohoro.com"
      ],
      "id": "/tenants/daea2e9b-847b-4c93-850d-2aa6f2d7af33",
      "tenantBrandingLogoUrl": "logo1.logo.rdvmohoro.com",
      "tenantCategory": "ProjectedBy",
      "tenantId": "daea2e9b-847b-4c93-850d-2aa6f2d7af33",
      "tenantType": "AAD"
    }
  ]
}

定義

名前	説明
CloudError	リソース管理要求のエラー応答。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
TenantCategory	テナントのカテゴリ。
TenantIdDescription	テナント ID 情報。
TenantListResult	テナント ID の情報。

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	エラーオブジェクト。

TenantCategory

列挙

テナントのカテゴリ。

値	説明
Home	ホーム
ProjectedBy	プロジェクテッド
ManagedBy	ManagedBy

TenantIdDescription

Object

テナント ID 情報。

名前	型	説明
country	string	テナントのアドレスの国/地域名。
countryCode	string	テナントの国/地域の省略形。
defaultDomain	string	テナントの既定のドメイン。
displayName	string	テナントの表示名。
domains	string[]	テナントのドメインの一覧。
id	string	テナントの完全修飾 ID。たとえば、/tenants/8d65815f-a5b6-402f-9298-045155da7d74
tenantBrandingLogoUrl	string	テナントのブランド化ロゴの URL。 "ホーム" テナントカテゴリでのみ使用できます。
tenantCategory	TenantCategory	テナントのカテゴリ。
tenantId	string	テナント ID。たとえば、8d65815f-a5b6-402f-9298-045155da7d74
tenantType	string	テナントの種類。 "ホーム" テナントカテゴリでのみ使用できます。

TenantListResult

Object

テナント ID の情報。

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