Tenants - List
アカウントのテナントを取得します。
GET https://management.azure.com/tenants?api-version=2022-12-01
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
OK - テナントの配列を返します。 |
|
| Other Status Codes |
操作が失敗した理由を説明するエラー応答。 |
セキュリティ
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
応答のサンプル
{
"value": [
{
"id": "/tenants/a70a1586-9c4a-4373-b907-1d310660dbd1",
"tenantId": "a70a1586-9c4a-4373-b907-1d310660dbd1",
"countryCode": "US",
"displayName": "Test_Test_aad50",
"domains": [
"aad50.ccsctp.net"
],
"tenantCategory": "ManagedBy",
"defaultDomain": "aad50.ccsctp.net",
"tenantType": "AAD"
},
{
"id": "/tenants/83abe5cd-bcc3-441a-bd86-e6a75360cecc",
"tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc",
"countryCode": "US",
"displayName": "Contoso Corp.",
"domains": [
"auxteststagemanual.ccsctp.net"
],
"tenantCategory": "Home",
"defaultDomain": "auxteststagemanual.ccsctp.net",
"tenantType": "AAD"
},
{
"id": "/tenants/daea2e9b-847b-4c93-850d-2aa6f2d7af33",
"tenantId": "daea2e9b-847b-4c93-850d-2aa6f2d7af33",
"countryCode": "US",
"displayName": "TEST_TEST_RDV",
"domains": [
"rdvmohoro.ccsctp.net",
"rdvmohoro.mail.ccsctp.net",
"rdvmohoro.com"
],
"tenantCategory": "ProjectedBy",
"defaultDomain": "rdvmohoro.ccsctp.net",
"tenantType": "AAD",
"tenantBrandingLogoUrl": "logo1.logo.rdvmohoro.com"
}
],
"nextLink": "..."
}
定義
| 名前 | 説明 |
|---|---|
|
Cloud |
リソース管理要求のエラー応答。 |
|
Error |
リソース管理エラーの追加情報。 |
|
Error |
エラーの詳細。 |
|
Error |
エラー応答 |
|
Tenant |
テナントのカテゴリ。 |
|
Tenant |
テナント ID 情報。 |
|
Tenant |
テナント ID の情報。 |
CloudError
リソース管理要求のエラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー応答 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
object |
追加情報。 |
| type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| details |
エラーの詳細。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーターゲット。 |
ErrorResponse
エラー応答
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー オブジェクト。 |
TenantCategory
テナントのカテゴリ。
| 値 | 説明 |
|---|---|
| Home | |
| ProjectedBy | |
| ManagedBy |
TenantIdDescription
テナント ID 情報。
| 名前 | 型 | 説明 |
|---|---|---|
| country |
string |
テナントのアドレスの国/地域名。 |
| countryCode |
string |
テナントの国/地域の省略形。 |
| defaultDomain |
string |
テナントの既定のドメイン。 |
| displayName |
string |
テナントの表示名。 |
| domains |
string[] |
テナントのドメインの一覧。 |
| id |
string |
テナントの完全修飾 ID。 たとえば、/tenants/8d65815f-a5b6-402f-9298-045155da7d74 |
| tenantBrandingLogoUrl |
string |
テナントのブランド化ロゴの URL。 "ホーム" テナント カテゴリでのみ使用できます。 |
| tenantCategory |
テナントのカテゴリ。 |
|
| tenantId |
string |
テナント ID。 たとえば、8d65815f-a5b6-402f-9298-045155da7d74 |
| tenantType |
string |
テナントの種類。 "ホーム" テナント カテゴリでのみ使用できます。 |
TenantListResult
テナント ID の情報。
| 名前 | 型 | 説明 |
|---|---|---|
| nextLink |
string |
次の結果セットの取得に使用する URL。 |
| value |
テナントの配列。 |