Delen via


Tenants - List

Haalt de tenants voor uw account op.

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

URI-parameters

Name In Vereist Type Description
api-version
query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name Type Description
200 OK

TenantListResult

OK: retourneert een matrix met tenants.

Other Status Codes

CloudError

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

GetAllTenants

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
CloudError

Een foutbericht voor een aanvraag voor resourcebeheer.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Foutreactie

TenantCategory

Categorie van de tenant.

TenantIdDescription

Tenant-id-gegevens.

TenantListResult

Informatie over tenant-id's.

CloudError

Een foutbericht voor een aanvraag voor resourcebeheer.

Name Type Description
error

ErrorResponse

Foutreactie
Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.

type

string

Het extra informatietype.

ErrorDetail

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout bevat aanvullende informatie.

code

string

De foutcode.

details

ErrorDetail[]

De foutdetails.

message

string

Het foutbericht.

target

string

Het foutdoel.

ErrorResponse

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

TenantCategory

Categorie van de tenant.

Waarde Description
Home
ManagedBy
ProjectedBy

TenantIdDescription

Tenant-id-gegevens.

Name Type Description
country

string

Land-/regionaam van het adres voor de tenant.

countryCode

string

Afkorting van land/regio voor de tenant.

defaultDomain

string

Het standaarddomein voor de tenant.

displayName

string

De weergavenaam van de tenant.

domains

string[]

De lijst met domeinen voor de tenant.

id

string

De volledig gekwalificeerde id van de tenant. Bijvoorbeeld /tenants/8d65815f-a5b6-402f-9298-045155da7d74

tenantBrandingLogoUrl

string

De url van het huisstijllogo van de tenant. Alleen beschikbaar voor de categorie 'Home'-tenant.

tenantCategory

TenantCategory

Categorie van de tenant.

tenantId

string

De tenant-id. Bijvoorbeeld 8d65815f-a5b6-402f-9298-045155da7d74

tenantType

string

Het tenanttype. Alleen beschikbaar voor de categorie 'Home'-tenant.

TenantListResult

Informatie over tenant-id's.

Name Type Description
nextLink

string

De URL die moet worden gebruikt voor het ophalen van de volgende set resultaten.

value

TenantIdDescription[]

Een matrix met tenants.