Udostępnij przez

Tenants - List

Usługa:
Resource Management
Wersja interfejsu API:
2022-12-01

Pobiera dzierżawy dla twojego konta.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
api-version
 query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa Typ Opis
200 OK

TenantListResult

OK — zwraca tablicę dzierżaw.
Other Status Codes

CloudError

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresów

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

GetAllTenants

Przykładowe zapytanie

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

Przykładowa odpowiedź

Kod stanu:
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": "..."
}

Definicje

Nazwa Opis
CloudError

Odpowiedź na błąd żądania zarządzania zasobami.
ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail

Szczegóły błędu.
ErrorResponse

Odpowiedź na błąd
TenantCategory

Kategoria dzierżawy.
TenantIdDescription

Informacje o identyfikatorze dzierżawy.
TenantListResult

Informacje o identyfikatorach dzierżawy.

CloudError

Sprzeciwiać się

Odpowiedź na błąd żądania zarządzania zasobami.

Nazwa Typ Opis
error

ErrorResponse

Odpowiedź na błąd
Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

ErrorAdditionalInfo

Sprzeciwiać się

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.
type

string

Dodatkowy typ informacji.

ErrorDetail

Sprzeciwiać się

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.
code

string

Kod błędu.
details

ErrorDetail[]

Szczegóły błędu.
message

string

Komunikat o błędzie.
target

string

Element docelowy błędu.

ErrorResponse

Sprzeciwiać się

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

TenantCategory

Wyliczenie

Kategoria dzierżawy.

Wartość Opis
Home
ProjectedBy
ManagedBy

TenantIdDescription

Sprzeciwiać się

Informacje o identyfikatorze dzierżawy.

Nazwa Typ Opis
country

string

Nazwa kraju/regionu adresu dzierżawy.
countryCode

string

Skrót kraju/regionu dla dzierżawy.
defaultDomain

string

Domena domyślna dzierżawy.
displayName

string

Nazwa wyświetlana dzierżawy.
domains

string[]

Lista domen dla dzierżawy.
id

string

W pełni kwalifikowany identyfikator dzierżawy. Na przykład /tenants/8d65815f-a5b6-402f-9298-045155da7d74
tenantBrandingLogoUrl

string

Adres URL logo znakowania dzierżawy. Dostępne tylko dla kategorii dzierżawy "Strona główna".
tenantCategory

TenantCategory

Kategoria dzierżawy.
tenantId

string

Identyfikator dzierżawy. Na przykład 8d65815f-a5b6-402f-9298-045155da7d74
tenantType

string

Typ dzierżawy. Dostępne tylko dla kategorii dzierżawy "Strona główna".

TenantListResult

Sprzeciwiać się

Informacje o identyfikatorach dzierżawy.

Nazwa Typ Opis
nextLink

string

Adres URL używany do pobierania następnego zestawu wyników.
value

TenantIdDescription[]

Tablica dzierżaw.