Tenants - List

Dienst:: Resource Management

API-Version:: 2022-12-01

Ruft die Mandanten für Ihr Konto ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	TenantListResult	Azure-Operation erfolgreich abgeschlossen.
Other Status Codes	CloudError	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

GetAllTenants

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.resource.subscriptions import SubscriptionClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-resource-subscriptions
# USAGE
    python get_tenants.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SubscriptionClient(
        credential=DefaultAzureCredential(),
    )

    response = client.tenants.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/subscriptions/stable/2022-12-01/examples/GetTenants.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:: 200

{
  "nextLink": "http://nextlink",
  "value": [
    {
      "countryCode": "US",
      "defaultDomain": "aad50.ccsctp.net",
      "displayName": "Test_Test_aad50",
      "domains": [
        "aad50.ccsctp.net"
      ],
      "id": "/tenants/a70a1586-9c4a-4373-b907-1d310660dbd1",
      "tenantCategory": "ManagedBy",
      "tenantId": "a70a1586-9c4a-4373-b907-1d310660dbd1",
      "tenantType": "AAD"
    },
    {
      "countryCode": "US",
      "defaultDomain": "auxteststagemanual.ccsctp.net",
      "displayName": "Contoso Corp.",
      "domains": [
        "auxteststagemanual.ccsctp.net"
      ],
      "id": "/tenants/83abe5cd-bcc3-441a-bd86-e6a75360cecc",
      "tenantCategory": "Home",
      "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc",
      "tenantType": "AAD"
    },
    {
      "countryCode": "US",
      "defaultDomain": "rdvmohoro.ccsctp.net",
      "displayName": "TEST_TEST_RDV",
      "domains": [
        "rdvmohoro.ccsctp.net",
        "rdvmohoro.mail.ccsctp.net",
        "rdvmohoro.com"
      ],
      "id": "/tenants/daea2e9b-847b-4c93-850d-2aa6f2d7af33",
      "tenantBrandingLogoUrl": "logo1.logo.rdvmohoro.com",
      "tenantCategory": "ProjectedBy",
      "tenantId": "daea2e9b-847b-4c93-850d-2aa6f2d7af33",
      "tenantType": "AAD"
    }
  ]
}

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort für eine Ressourcenverwaltungsanforderung.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
TenantCategory	Kategorie des Mandanten.
TenantIdDescription	Informationen zur Mandanten-ID.
TenantListResult	Informationen zu Mandanten-IDs.

CloudError

Objekt

Eine Fehlerantwort für eine Ressourcenverwaltungsanforderung.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

TenantCategory

Enumeration

Kategorie des Mandanten.

Wert	Beschreibung
Home	Heim
ProjectedBy	ProjectedBy
ManagedBy	ManagedBy

TenantIdDescription

Objekt

Informationen zur Mandanten-ID.

Name	Typ	Beschreibung
country	string	Name des Landes/der Region der Adresse für den Mandanten.
countryCode	string	Abkürzung für Land/Region für den Mandanten.
defaultDomain	string	Die Standarddomäne für den Mandanten.
displayName	string	Der Anzeigename des Mandanten.
domains	string[]	Die Liste der Domänen für den Mandanten.
id	string	Die vollqualifizierte ID des Mandanten. Beispiel: /tenants/8d65815f-a5b6-402f-9298-045155da7d74
tenantBrandingLogoUrl	string	Die Brandinglogo-URL des Mandanten. Nur für die Mandantenkategorie "Start" verfügbar.
tenantCategory	TenantCategory	Kategorie des Mandanten.
tenantId	string	Die Mandanten-ID. Beispiel: 8d65815f-a5b6-402f-9298-045155da7d74
tenantType	string	Der Mandanttyp. Nur für die Mandantenkategorie "Start" verfügbar.

TenantListResult

Objekt

Informationen zu Mandanten-IDs.

Name	Typ	Beschreibung
nextLink	string (uri)	Der Link zur nächsten Seite von Elementen
value	TenantIdDescription[]	Die TenantIdDescription-Einträge auf dieser Seite

Freigeben über

Tenants - List

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

GetAllTenants

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CloudError

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

TenantCategory

TenantIdDescription

TenantListResult