다음을 통해 공유

Tenants - List

서비스:
Resource Management
API 버전:
2022-12-01

계정에 대한 테넌트 가져옵니다.

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
api-version
 query True

string

minLength: 1

이 작업에 사용할 API 버전입니다.

응답

Name 형식 Description
200 OK

TenantListResult

OK - 테넌트 배열을 반환합니다.
Other Status Codes

CloudError

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 흐름

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name Description
user_impersonation 사용자 계정 가장

예제

GetAllTenants

샘플 요청

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

샘플 응답

상태 코드:
200 
{
  "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": "..."
}

정의

Name Description
CloudError

리소스 관리 요청에 대한 오류 응답입니다.
ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.
ErrorDetail

오류 세부 정보입니다.
ErrorResponse

오류 응답
TenantCategory

테넌트 범주입니다.
TenantIdDescription

테넌트 ID 정보입니다.
TenantListResult

테넌트 ID 정보입니다.

CloudError

Object

리소스 관리 요청에 대한 오류 응답입니다.

Name 형식 Description
error

ErrorResponse

오류 응답
실패한 작업에 대한 오류 세부 정보를 반환하는 모든 Azure Resource Manager API에 대한 일반적인 오류 응답입니다. 또한 OData 오류 응답 형식을 따릅니다.

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name 형식 Description
info

object

추가 정보입니다.
type

string

추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name 형식 Description
additionalInfo

ErrorAdditionalInfo[]

오류 추가 정보입니다.
code

string

오류 코드입니다.
details

ErrorDetail[]

오류 세부 정보입니다.
message

string

오류 메시지입니다.
target

string

오류 대상입니다.

ErrorResponse

Object

오류 응답

Name 형식 Description
error

ErrorDetail

오류 개체입니다.

TenantCategory

열거형

테넌트 범주입니다.

값 Description
Home
ProjectedBy
ManagedBy

TenantIdDescription

Object

테넌트 ID 정보입니다.

Name 형식 Description
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 정보입니다.

Name 형식 Description
nextLink

string

다음 결과 집합을 가져오는 데 사용할 URL입니다.
value

TenantIdDescription[]

테넌트 배열입니다.