Dela via


Tenants - List

Hämtar klientorganisationen för ditt konto.

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

URI-parametrar

Name I Obligatorisk Typ Description
api-version
query True

string

Den API-version som ska användas för den här åtgärden.

Svar

Name Typ Description
200 OK

TenantListResult

OK – Returnerar en matris med klienter.

Other Status Codes

CloudError

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

GetAllTenants

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
CloudError

Ett felsvar för en resurshanteringsbegäran.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

TenantCategory

Klientorganisationens kategori.

TenantIdDescription

Information om klientorganisations-ID.

TenantListResult

Information om klientorganisations-ID:t.

CloudError

Ett felsvar för en resurshanteringsbegäran.

Name Typ Description
error

ErrorResponse

Felsvar
Vanliga felsvar för alla Azure Resource Manager API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även OData-felsvarsformatet.).

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.

type

string

Den ytterligare informationstypen.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.

TenantCategory

Klientorganisationens kategori.

Name Typ Description
Home

string

ManagedBy

string

ProjectedBy

string

TenantIdDescription

Information om klientorganisations-ID.

Name Typ Description
country

string

Namn på land/region för adressen för klientorganisationen.

countryCode

string

Lands-/regionförkortning för klientorganisationen.

defaultDomain

string

Standarddomänen för klientorganisationen.

displayName

string

Klientorganisationens visningsnamn.

domains

string[]

Listan över domäner för klientorganisationen.

id

string

Klientorganisationens fullständigt kvalificerade ID. Till exempel /tenants/8d65815f-a5b6-402f-9298-045155da7d74

tenantBrandingLogoUrl

string

Klientens varumärkeslogotyps-URL. Endast tillgängligt för klientkategorin "Start".

tenantCategory

TenantCategory

Klientorganisationens kategori.

tenantId

string

Klientorganisations-ID:t. Till exempel 8d65815f-a5b6-402f-9298-045155da7d74

tenantType

string

Klienttypen. Endast tillgängligt för klientkategorin "Start".

TenantListResult

Information om klientorganisations-ID:t.

Name Typ Description
nextLink

string

Url:en som ska användas för att hämta nästa uppsättning resultat.

value

TenantIdDescription[]

En matris med klienter.