AFD Custom Domains - Get

Služba:: Front Door Service

Verze rozhraní API:: 2025-04-15

Získá existující doménu AzureFrontDoor se zadaným názvem domény pod zadaným předplatným, skupinou prostředků a profilem.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/customDomains/{customDomainName}?api-version=2025-04-15

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
customDomainName	path	True	string	Název domény pod profilem, který je globálně jedinečný.
profileName	path	True	string minLength: 1 maxLength: 260 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9])$	Název služby Azure Front Door Standard nebo Azure Front Door Premium, který je jedinečný v rámci skupiny prostředků.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Název skupiny prostředků v rámci předplatného Azure
subscriptionId	path	True	string	ID předplatného Azure.
api-version	query	True	string	Verze rozhraní API, která se má použít s požadavkem klienta. Aktuální verze je 15. 4. 2025.

Odpovědi

Name	Typ	Description
200 OK	AFDDomain	OK
Other Status Codes	AfdErrorResponse	Odpověď na chybu služby Azure Front Door popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

AFDCustomDomains_Get

Ukázkový požadavek

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/customDomains/domain1?api-version=2025-04-15

Ukázková odpověď

Stavový kód:: 200

{
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/customdomains/domain1",
  "name": "domain1",
  "type": "Microsoft.Cdn/profiles/customdomains",
  "properties": {
    "profileName": "profile1",
    "hostName": "www.contoso.com",
    "tlsSettings": {
      "certificateType": "ManagedCertificate",
      "cipherSuiteSetType": "Customized",
      "minimumTlsVersion": "TLS12",
      "customizedCipherSuiteSet": {
        "cipherSuiteSetForTls12": [
          "ECDHE_RSA_AES128_GCM_SHA256"
        ],
        "cipherSuiteSetForTls13": [
          "TLS_AES_128_GCM_SHA256",
          "TLS_AES_256_GCM_SHA384"
        ]
      },
      "secret": {
        "id": ""
      }
    },
    "azureDnsZone": {
      "id": ""
    },
    "preValidatedCustomDomainResourceId": {
      "id": ""
    },
    "validationProperties": {
      "validationToken": "8c9912db-c615-4eeb-8465",
      "expirationDate": "2009-06-15T13:45:43.0000000Z"
    },
    "domainValidationState": "Pending",
    "provisioningState": "Updating",
    "deploymentStatus": "NotStarted"
  }
}

Definice

Name	Description
AfdCertificateType	Definuje zdroj certifikátu SSL.
AfdCipherSuiteSetType	Typ sady šifer, který se použije pro https
AfdCustomizedCipherSuiteForTls12	Šifrovací sady pro PROTOKOL TLS 1.2. Vyžaduje se minimálně jeden v protokolu MINIMUMTlsVersion TLS 1.2.
AfdCustomizedCipherSuiteForTls13	Šifrovací sady pro PROTOKOL TLS 1.3. Vyžaduje se minimálně jeden v minimumTlsVersion TLS 1.2, TLS 1.3.
AFDDomain	Popisné mapování názvu domény na název hostitele koncového bodu, který zákazník poskytne pro účely brandingu, např. `www.contoso.com`.
AFDDomainHttpsCustomizedCipherSuiteSet	Přizpůsobený objekt sady šifer, který se použije pro Https při cipherSuiteSetType je Customized.
AFDDomainHttpsParameters	Objekt JSON, který obsahuje vlastnosti pro zabezpečení domény.
AfdErrorResponse	Chybová odpověď
AfdMinimumTlsVersion	Verze protokolu TLS, která se použije pro protokol Https při přizpůsobení cipherSuiteSetType.
AfdProvisioningState	Stav zřizování
DeploymentStatus
DomainValidationProperties	Objekt JSON, který obsahuje vlastnosti pro ověření domény.
DomainValidationState	Dílčí stav zřizování ukazuje průběh vlastního procesu povolení nebo zakázání HTTPS krok za krokem. DCV je zkratka pro DomainControlValidation.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
IdentityType	Typ identity, která vytváří nebo upravuje prostředky
ResourceReference	Odkaz na jiný prostředek
SystemData	Systémová data jen pro čtení

AfdCertificateType

Výčet

Definuje zdroj certifikátu SSL.

Hodnota	Description
CustomerCertificate
ManagedCertificate
AzureFirstPartyManagedCertificate

AfdCipherSuiteSetType

Výčet

Typ sady šifer, který se použije pro https

Hodnota	Description
Customized
TLS10_2019
TLS12_2022
TLS12_2023

AfdCustomizedCipherSuiteForTls12

Výčet

Šifrovací sady pro PROTOKOL TLS 1.2. Vyžaduje se minimálně jeden v protokolu MINIMUMTlsVersion TLS 1.2.

Hodnota	Description
ECDHE_RSA_AES128_GCM_SHA256
ECDHE_RSA_AES256_GCM_SHA384
DHE_RSA_AES256_GCM_SHA384
DHE_RSA_AES128_GCM_SHA256
ECDHE_RSA_AES128_SHA256
ECDHE_RSA_AES256_SHA384

AfdCustomizedCipherSuiteForTls13

Výčet

Šifrovací sady pro PROTOKOL TLS 1.3. Vyžaduje se minimálně jeden v minimumTlsVersion TLS 1.2, TLS 1.3.

Hodnota	Description
TLS_AES_128_GCM_SHA256
TLS_AES_256_GCM_SHA384

AFDDomain

Objekt

Popisné mapování názvu domény na název hostitele koncového bodu, který zákazník poskytne pro účely brandingu, např. www.contoso.com.

Name	Typ	Description
id	string	ID prostředku.
name	string	Název prostředku
properties.azureDnsZone	ResourceReference	Odkaz na prostředek zóny Azure DNS
properties.deploymentStatus	DeploymentStatus
properties.domainValidationState	DomainValidationState	Dílčí stav zřizování ukazuje průběh vlastního procesu povolení nebo zakázání HTTPS krok za krokem. DCV je zkratka pro DomainControlValidation.
properties.extendedProperties	object	Key-Value pár představující vlastnosti migrace pro domény.
properties.hostName	string	Název hostitele domény. Musí to být název domény.
properties.preValidatedCustomDomainResourceId	ResourceReference	Odkaz na prostředek Azure, ve kterém bylo vlastnictví vlastní domény předvalidováno
properties.profileName	string	Název profilu, který obsahuje doménu.
properties.provisioningState	AfdProvisioningState	Stav zřizování
properties.tlsSettings	AFDDomainHttpsParameters	Konfigurace určující, jak povolit HTTPS pro doménu – pomocí spravovaného certifikátu AzureFrontDoor nebo vlastního certifikátu uživatele. Pokud není zadaný, povolení ssl ve výchozím nastavení používá spravovaný certifikát AzureFrontDoor.
properties.validationProperties	DomainValidationProperties	Hodnoty, které zákazník potřebuje k ověření vlastnictví domény
systemData	SystemData	Systémová data jen pro čtení
type	string	Typ prostředku.

AFDDomainHttpsCustomizedCipherSuiteSet

Objekt

Přizpůsobený objekt sady šifer, který se použije pro Https při cipherSuiteSetType je Customized.

Name	Typ	Description
cipherSuiteSetForTls12	AfdCustomizedCipherSuiteForTls12[]	Šifrovací sady pro PROTOKOL TLS 1.2. Vyžaduje se minimálně jeden v protokolu MINIMUMTlsVersion TLS 1.2.
cipherSuiteSetForTls13	AfdCustomizedCipherSuiteForTls13[]	Šifrovací sady pro PROTOKOL TLS 1.3. Vyžaduje se minimálně jeden v minimumTlsVersion TLS 1.2, TLS 1.3.

AFDDomainHttpsParameters

Objekt

Objekt JSON, který obsahuje vlastnosti pro zabezpečení domény.

Name	Typ	Description
certificateType	AfdCertificateType	Definuje zdroj certifikátu SSL.
cipherSuiteSetType	AfdCipherSuiteSetType	Typ sady šifer, který se použije pro https
customizedCipherSuiteSet	AFDDomainHttpsCustomizedCipherSuiteSet	Přizpůsobený objekt šifrovacích sad, který se použije pro Https při cipherSuiteSetType je Customized.
minimumTlsVersion	AfdMinimumTlsVersion	Verze protokolu TLS, která se použije pro protokol Https při přizpůsobení cipherSuiteSetType.
secret	ResourceReference	Odkaz na prostředek na tajný kód. Ie. subs/rg/profile/secret

AfdErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

AfdMinimumTlsVersion

Výčet

Verze protokolu TLS, která se použije pro protokol Https při přizpůsobení cipherSuiteSetType.

Hodnota	Description
TLS10
TLS12
TLS13

AfdProvisioningState

Výčet

Stav zřizování

Hodnota	Description
Succeeded
Failed
Updating
Deleting
Creating

DeploymentStatus

Výčet

Hodnota	Description
NotStarted
InProgress
Succeeded
Failed

DomainValidationProperties

Objekt

Objekt JSON, který obsahuje vlastnosti pro ověření domény.

Name	Typ	Description
expirationDate	string	Datum vypršení platnosti tokenu
validationToken	string	Výzva použitá pro ověření záznamu DNS TXT nebo souboru

DomainValidationState

Výčet

Dílčí stav zřizování ukazuje průběh vlastního procesu povolení nebo zakázání HTTPS krok za krokem. DCV je zkratka pro DomainControlValidation.

Hodnota	Description
Unknown
Submitting
Pending
Rejected
TimedOut
PendingRevalidation
Approved
RefreshingValidationToken
InternalError

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

IdentityType

Výčet

Typ identity, která vytváří nebo upravuje prostředky

Hodnota	Description
user
application
managedIdentity
key

ResourceReference

Objekt

Odkaz na jiný prostředek

Name	Typ	Description
id	string	ID prostředku.

SystemData

Objekt

Systémová data jen pro čtení

Name	Typ	Description
createdAt	string (date-time)	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identifikátor identity, která vytvořila prostředek
createdByType	IdentityType	Typ identity, která prostředek vytvořila
lastModifiedAt	string (date-time)	Časové razítko poslední změny zdroje (UTC)
lastModifiedBy	string	Identifikátor identity, která naposledy změnila prostředek
lastModifiedByType	IdentityType	Typ identity, která naposledy změnila prostředek

Sdílet prostřednictvím

AFD Custom Domains - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

AFDCustomDomains_Get

Ukázkový požadavek

Ukázková odpověď

Definice

AfdCertificateType

AfdCipherSuiteSetType

AfdCustomizedCipherSuiteForTls12

AfdCustomizedCipherSuiteForTls13

AFDDomain

AFDDomainHttpsCustomizedCipherSuiteSet

AFDDomainHttpsParameters

AfdErrorResponse

AfdMinimumTlsVersion

AfdProvisioningState

DeploymentStatus

DomainValidationProperties

DomainValidationState

ErrorAdditionalInfo

ErrorDetail

IdentityType

ResourceReference

SystemData