Freigeben über


Domains - List

Beschreibung für "Alle Domänen in einem Abonnement abrufen".

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/domains?api-version=2024-11-01

URI-Parameter

Name In Erforderlich Typ Beschreibung
subscriptionId
path True

string

die Azure-Abonnement-ID Dies ist eine GUID-formatierte Zeichenfolge (z. B. 0000000-0000-0000-0000-000000000000).

api-version
query True

string

API-Version

Antworten

Name Typ Beschreibung
200 OK

DomainCollection

OKAY

Other Status Codes

DefaultErrorResponse

Fehlerantwort des App-Diensts.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

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

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

List domains by subscription

Beispielanforderung

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/domains?api-version=2024-11-01

Beispiel für eine Antwort

{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com",
      "name": "example.com",
      "type": "Microsoft.DomainRegistration/domains",
      "location": "global",
      "tags": {},
      "properties": {
        "authCode": "exampleAuthCode",
        "registrationStatus": "Active",
        "provisioningState": "Succeeded",
        "nameServers": [
          "ns01.ote.domaincontrol.com",
          "ns02.ote.domaincontrol.com"
        ],
        "privacy": false,
        "createdTime": "2021-09-10T19:30:53Z",
        "expirationTime": "2022-09-10T19:30:53Z",
        "autoRenew": true,
        "readyForDnsRecordManagement": true,
        "managedHostNames": [],
        "domainNotRenewableReasons": [
          "ExpirationNotInRenewalTimeRange"
        ],
        "dnsType": "DefaultDomainRegistrarDns",
        "consent": {
          "agreementKeys": [
            "agreementKey1"
          ],
          "agreedBy": "192.0.2.1",
          "agreedAt": "2021-09-10T19:30:53Z"
        },
        "contactTech": {
          "email": "tech@email.com",
          "fax": "1-245-534-2242",
          "nameFirst": "John",
          "nameLast": "Doe",
          "nameMiddle": "",
          "jobTitle": "Tech",
          "organization": "Microsoft Inc.",
          "phone": "1-245-534-2242",
          "addressMailing": {
            "address1": "3400 State St",
            "city": "Chicago",
            "state": "IL",
            "country": "United States",
            "postalCode": "67098"
          }
        },
        "contactBilling": {
          "email": "billing@email.com",
          "fax": "1-245-534-2242",
          "nameFirst": "John",
          "nameLast": "Doe",
          "nameMiddle": "",
          "jobTitle": "Billing",
          "organization": "Microsoft Inc.",
          "phone": "1-245-534-2242",
          "addressMailing": {
            "address1": "3400 State St",
            "city": "Chicago",
            "state": "IL",
            "country": "United States",
            "postalCode": "67098"
          }
        },
        "contactAdmin": {
          "email": "admin@email.com",
          "fax": "1-245-534-2242",
          "nameFirst": "John",
          "nameLast": "Doe",
          "nameMiddle": "",
          "jobTitle": "Admin",
          "organization": "Microsoft Inc.",
          "phone": "1-245-534-2242",
          "addressMailing": {
            "address1": "3400 State St",
            "city": "Chicago",
            "state": "IL",
            "country": "United States",
            "postalCode": "67098"
          }
        },
        "contactRegistrant": {
          "email": "registrant@email.com",
          "fax": "1-245-534-2242",
          "nameFirst": "John",
          "nameLast": "Doe",
          "nameMiddle": "",
          "jobTitle": "Registrant",
          "organization": "Microsoft Inc.",
          "phone": "1-245-534-2242",
          "addressMailing": {
            "address1": "3400 State St",
            "city": "Chicago",
            "state": "IL",
            "country": "United States",
            "postalCode": "67098"
          }
        }
      }
    }
  ]
}

Definitionen

Name Beschreibung
Address

Adressinformationen für die Domänenregistrierung.

AzureResourceType

Der Typ der Azure-Ressource, der der Hostname zugewiesen ist.

Contact

Kontaktinformationen für die Domänenregistrierung. Wenn die Option "Domänendatenschutz" nicht ausgewählt ist, werden die Kontaktinformationen über die Whois-Verzeichnisse gemäß den ICANN-Anforderungen öffentlich zugänglich gemacht.

CustomHostNameDnsRecordType

Typ des DNS-Eintrags.

DefaultErrorResponse

Fehlerantwort des App-Diensts.

Details
DnsType

Aktueller DNS-Typ

Domain

Informationen zu einer Domäne.

DomainCollection

Sammlung von Domänen.

DomainPurchaseConsent

Zustimmungsobjekt des Domänenkaufs, das die Annahme anwendbarer rechtlicher Vereinbarungen darstellt.

DomainStatus

Domänenregistrierungsstatus.

Error

Fehlermodell.

HostName

Details eines Hostnamens, der von einer Domäne abgeleitet ist.

HostNameType

Typ des Hostnamens.

ProvisioningState

Domänenbereitstellungsstatus.

ResourceNotRenewableReason

Gründe, warum die Domäne nicht verwendbar ist.

Address

Adressinformationen für die Domänenregistrierung.

Name Typ Beschreibung
address1

string

Erste Zeile einer Adresse.

address2

string

Die zweite Zeile der Adresse. Wahlfrei.

city

string

Die Stadt für die Adresse.

country

string

Das Land für die Adresse.

postalCode

string

Die Postleitzahl für die Adresse.

state

string

Das Bundesland oder die Provinz für die Adresse.

AzureResourceType

Der Typ der Azure-Ressource, der der Hostname zugewiesen ist.

Wert Beschreibung
TrafficManager
Website

Contact

Kontaktinformationen für die Domänenregistrierung. Wenn die Option "Domänendatenschutz" nicht ausgewählt ist, werden die Kontaktinformationen über die Whois-Verzeichnisse gemäß den ICANN-Anforderungen öffentlich zugänglich gemacht.

Name Typ Beschreibung
addressMailing

Address

Postanschrift.

email

string

E-Mail-Adresse.

fax

string

Faxnummer.

jobTitle

string

Berufsbezeichnung.

nameFirst

string

Vorname.

nameLast

string

Nachname.

nameMiddle

string

Zweitname.

organization

string

Der Organisationskontakt gehört zu.

phone

string

Telefonnummer.

CustomHostNameDnsRecordType

Typ des DNS-Eintrags.

Wert Beschreibung
A
CName

DefaultErrorResponse

Fehlerantwort des App-Diensts.

Name Typ Beschreibung
error

Error

Fehlermodell.

Details

Name Typ Beschreibung
code

string

Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.

message

string

Detaillierte Fehlerbeschreibung und Debuginformationen.

target

string

Detaillierte Fehlerbeschreibung und Debuginformationen.

DnsType

Aktueller DNS-Typ

Wert Beschreibung
AzureDns
DefaultDomainRegistrarDns

Domain

Informationen zu einer Domäne.

Name Typ Standardwert Beschreibung
id

string

Ressourcen-ID.

kind

string

Art der Ressource. Wenn es sich bei der Ressource um eine App handelt, können Sie auf https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference für details unterstützte Werte für die Art verweisen.

location

string

Ressourcenspeicherort.

name

string

Ressourcenname.

properties.authCode

string

properties.autoRenew

boolean

True

true, wenn die Domäne automatisch verlängert werden soll; andernfalls false.

properties.consent

DomainPurchaseConsent

Zustimmung zu rechtlichen Vereinbarungen.

properties.contactAdmin

Contact

Administrativer Kontakt.

properties.contactBilling

Contact

Abrechnungskontakt.

properties.contactRegistrant

Contact

Kontakt des Registranten.

properties.contactTech

Contact

Technischer Kontakt:

properties.createdTime

string (date-time)

Zeitstempel für die Domänenerstellung.

properties.dnsType

DnsType

Aktueller DNS-Typ

properties.dnsZoneId

string

Zu verwendende Azure DNS-Zone

properties.domainNotRenewableReasons

ResourceNotRenewableReason[]

Gründe, warum die Domäne nicht verwendbar ist.

properties.expirationTime

string (date-time)

Zeitstempel für den Domänenablauf.

properties.lastRenewedTime

string (date-time)

Zeitstempel, zu dem die Domäne zuletzt verlängert wurde.

properties.managedHostNames

HostName[]

Alle Hostnamen, die von der Domäne abgeleitet und Azure-Ressourcen zugewiesen wurden.

properties.nameServers

string[]

Namenserver.

properties.privacy

boolean

true, wenn der Domänendatenschutz für diese Domäne aktiviert ist; andernfalls false.

properties.provisioningState

ProvisioningState

Domänenbereitstellungsstatus.

properties.readyForDnsRecordManagement

boolean

true, wenn Azure diese Domäne App Service-Apps zuweisen kann; andernfalls false. Dieser Wert wird true, wenn der Domänenregistrierungsstatus aktiv ist und auf Namenservern gehostet wird, auf die Azure programmgesteuerten Zugriff hat.

properties.registrationStatus

DomainStatus

Domänenregistrierungsstatus.

properties.targetDnsType

DnsType

Ziel-DNS-Typ (wird für die Migration verwendet)

tags

object

Ressourcentags.

type

string

Ressourcentyp.

DomainCollection

Sammlung von Domänen.

Name Typ Beschreibung
nextLink

string

Link zur nächsten Seite von Ressourcen.

value

Domain[]

Sammlung von Ressourcen.

DomainPurchaseConsent

Zustimmungsobjekt des Domänenkaufs, das die Annahme anwendbarer rechtlicher Vereinbarungen darstellt.

Name Typ Beschreibung
agreedAt

string (date-time)

Zeitstempel, als die Vereinbarungen akzeptiert wurden.

agreedBy

string

Client-IP-Adresse.

agreementKeys

string[]

Liste der anwendbaren Rechtlichen Vereinbarungsschlüssel. Diese Liste kann mithilfe der ListLegalAgreements-API unter TopLevelDomain Ressource abgerufen werden.

DomainStatus

Domänenregistrierungsstatus.

Wert Beschreibung
Active
Awaiting
Cancelled
Confiscated
Disabled
Excluded
Expired
Failed
Held
JsonConverterFailed
Locked
Parked
Pending
Reserved
Reverted
Suspended
Transferred
Unknown
Unlocked
Unparked
Updated

Error

Fehlermodell.

Name Typ Beschreibung
code

string

Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.

details

Details[]

Detaillierte Fehler.

innererror

string

Weitere Informationen zum Debuggen von Fehlern.

message

string

Detaillierte Fehlerbeschreibung und Debuginformationen.

target

string

Detaillierte Fehlerbeschreibung und Debuginformationen.

HostName

Details eines Hostnamens, der von einer Domäne abgeleitet ist.

Name Typ Beschreibung
azureResourceName

string

Der Name der Azure-Ressource, der der Hostname zugewiesen ist. Wenn sie einem Datenverkehrs-Manager zugewiesen ist, handelt es sich um den Namen des Datenverkehrs-Managers, andernfalls handelt es sich um den App-Namen.

azureResourceType

AzureResourceType

Der Typ der Azure-Ressource, der der Hostname zugewiesen ist.

customHostNameDnsRecordType

CustomHostNameDnsRecordType

Typ des DNS-Eintrags.

hostNameType

HostNameType

Typ des Hostnamens.

name

string

Name des Hostnamens.

siteNames

string[]

Liste der Apps, denen der Hostname zugewiesen ist. Diese Liste enthält nur dann mehr als eine App, wenn der Hostname auf einen Traffic Manager verweist.

HostNameType

Typ des Hostnamens.

Wert Beschreibung
Managed
Verified

ProvisioningState

Domänenbereitstellungsstatus.

Wert Beschreibung
Canceled
Deleting
Failed
InProgress
Succeeded

ResourceNotRenewableReason

Gründe, warum die Domäne nicht verwendbar ist.

Wert Beschreibung
ExpirationNotInRenewalTimeRange
RegistrationStatusNotSupportedForRenewal
SubscriptionNotActive