Domains - Get

Odwołanie

Service:: App Service

API Version:: 2023-12-01

Opis pobierania domeny.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}?api-version=2023-12-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
domainName	path	True	string	Nazwa domeny.
resourceGroupName	path	True	string	Nazwa grupy zasobów, do której należy zasób. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Azure. Jest to ciąg w formacie GUID (np. 00000000-0000-0000-0000-0000-000000000000).
api-version	query	True	string	Wersja interfejsu API

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Domain	OK
Other Status Codes	DefaultErrorResponse	App Service odpowiedź na błąd.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Get Domain

Sample Request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com?api-version=2023-12-01

Sample Response

Status code:: 200

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

Definicje

Nazwa	Opis
Address	Informacje o adresie rejestracji domeny.
AzureResourceType	Typ zasobu platformy Azure, do którym jest przypisana nazwa hosta.
Contact	Informacje kontaktowe dotyczące rejestracji domeny. Jeśli opcja "Prywatność domeny" nie zostanie wybrana, informacje kontaktowe są udostępniane publicznie za pośrednictwem katalogów Whois zgodnie z wymaganiami ICANN.
CustomHostNameDnsRecordType	Typ rekordu DNS.
DefaultErrorResponse	App Service odpowiedź na błąd.
Details
DnsType	Bieżący typ DNS
Domain	Informacje o domenie.
DomainPurchaseConsent	Obiekt zgody na zakup domeny reprezentujący akceptację odpowiednich umów prawnych.
DomainStatus	Stan rejestracji domeny.
Error	Model błędu.
HostName	Szczegóły nazwy hosta pochodzącej z domeny.
HostNameType	Wpisz nazwę hosta.
ProvisioningState	Stan aprowizacji domeny.
ResourceNotRenewableReason	Powody, dla których domena nie jest odnawialna.

Address

Informacje o adresie rejestracji domeny.

Nazwa	Typ	Opis
address1	string	Pierwszy wiersz adresu.
address2	string	Drugi wiersz adresu. Opcjonalny.
city	string	Miasto adresu.
country	string	Kraj adresu.
postalCode	string	Kod pocztowy adresu.
state	string	Stan lub prowincja adresu.

AzureResourceType

Typ zasobu platformy Azure, do którym jest przypisana nazwa hosta.

Nazwa	Typ	Opis
TrafficManager	string
Website	string

Contact

Informacje kontaktowe dotyczące rejestracji domeny. Jeśli opcja "Prywatność domeny" nie zostanie wybrana, informacje kontaktowe są udostępniane publicznie za pośrednictwem katalogów Whois zgodnie z wymaganiami ICANN.

Nazwa	Typ	Opis
addressMailing	Address	Adres wysyłkowy.
email	string	Adres e-mail.
fax	string	Numer faksu.
jobTitle	string	Stanowisko.
nameFirst	string	Imię.
nameLast	string	Nazwisko.
nameMiddle	string	Drugie imię.
organization	string	Kontakt z organizacją należy do.
phone	string	Numer telefonu.

CustomHostNameDnsRecordType

Typ rekordu DNS.

Nazwa	Typ	Opis
A	string
CName	string

DefaultErrorResponse

App Service odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Model błędu.

Details

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg w celu programowego identyfikowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

DnsType

Bieżący typ DNS

Nazwa	Typ	Opis
AzureDns	string
DefaultDomainRegistrarDns	string

Domain

Informacje o domenie.

Nazwa	Typ	Wartość domyślna	Opis
id	string		Identyfikator zasobu.
kind	string		Rodzaj zasobu.
location	string		Lokalizacja zasobu.
name	string		Nazwa zasobu.
properties.authCode	string
properties.autoRenew	boolean	True	`true` jeśli domena powinna zostać automatycznie odnowiona; w przeciwnym razie , `false`.
properties.consent	DomainPurchaseConsent		Zgoda na umowę prawną.
properties.contactAdmin	Contact		Kontakt administracyjny.
properties.contactBilling	Contact		Kontakt rozliczeniowy.
properties.contactRegistrant	Contact		Kontakt rejestrujący.
properties.contactTech	Contact		Kontakt techniczny.
properties.createdTime	string		Sygnatura czasowa tworzenia domeny.
properties.dnsType	DnsType		Bieżący typ DNS
properties.dnsZoneId	string		Strefa DNS platformy Azure do użycia
properties.domainNotRenewableReasons	ResourceNotRenewableReason[]		Powody, dla których domena nie jest odnawialna.
properties.expirationTime	string		Sygnatura czasowa wygaśnięcia domeny.
properties.lastRenewedTime	string		Sygnatura czasowa ostatniego odnowienia domeny.
properties.managedHostNames	HostName[]		Wszystkie nazwy hostów pochodzące z domeny i przypisane do zasobów platformy Azure.
properties.nameServers	string[]		Serwery nazw.
properties.privacy	boolean		`true` jeśli dla tej domeny włączono prywatność domeny; w przeciwnym razie , `false`.
properties.provisioningState	ProvisioningState		Stan aprowizacji domeny.
properties.readyForDnsRecordManagement	boolean		`true`jeśli platforma Azure może przypisać tę domenę do App Service aplikacji; w przeciwnym razie . `false` Ta wartość będzie mieć `true` wartość, jeśli stan rejestracji domeny jest aktywny i jest hostowany na serwerach nazw platformy Azure ma dostęp programowy.
properties.registrationStatus	DomainStatus		Stan rejestracji domeny.
properties.targetDnsType	DnsType		Docelowy typ DNS (będzie używany do migracji)
tags	object		Tagi zasobów.
type	string		Typ zasobu.

DomainPurchaseConsent

Obiekt zgody na zakup domeny reprezentujący akceptację odpowiednich umów prawnych.

Nazwa	Typ	Opis
agreedAt	string	Sygnatura czasowa zaakceptowania umów.
agreedBy	string	Adres IP klienta.
agreementKeys	string[]	Lista odpowiednich kluczy umów prawnych. Tę listę można pobrać przy użyciu interfejsu API ListLegalAgreements w obszarze `TopLevelDomain` zasobu.

DomainStatus

Stan rejestracji domeny.

Nazwa	Typ	Opis
Active	string
Awaiting	string
Cancelled	string
Confiscated	string
Disabled	string
Excluded	string
Expired	string
Failed	string
Held	string
JsonConverterFailed	string
Locked	string
Parked	string
Pending	string
Reserved	string
Reverted	string
Suspended	string
Transferred	string
Unknown	string
Unlocked	string
Unparked	string
Updated	string

Error

Model błędu.

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg w celu programowego identyfikowania błędu.
details	Details[]	Szczegółowe błędy.
innererror	string	Więcej informacji na temat debugowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

HostName

Szczegóły nazwy hosta pochodzącej z domeny.

Nazwa	Typ	Opis
azureResourceName	string	Nazwa zasobu platformy Azure, do której jest przypisana nazwa hosta. Jeśli zostanie przypisana do usługi Traffic Manager, będzie to nazwa usługi Traffic Manager. W przeciwnym razie będzie to nazwa aplikacji.
azureResourceType	AzureResourceType	Typ zasobu platformy Azure, do którym jest przypisana nazwa hosta.
customHostNameDnsRecordType	CustomHostNameDnsRecordType	Typ rekordu DNS.
hostNameType	HostNameType	Wpisz nazwę hosta.
name	string	Nazwa hosta.
siteNames	string[]	Lista aplikacji, do których jest przypisana nazwa hosta. Ta lista będzie zawierać więcej niż jedną aplikację tylko wtedy, gdy nazwa hosta wskazuje usługę Traffic Manager.

HostNameType

Wpisz nazwę hosta.

Nazwa	Typ	Opis
Managed	string
Verified	string

ProvisioningState

Stan aprowizacji domeny.

Nazwa	Typ	Opis
Canceled	string
Deleting	string
Failed	string
InProgress	string
Succeeded	string

ResourceNotRenewableReason

Powody, dla których domena nie jest odnawialna.

Nazwa	Typ	Opis
ExpirationNotInRenewalTimeRange	string
RegistrationStatusNotSupportedForRenewal	string
SubscriptionNotActive	string