AFD Custom Domains - Get

Szolgáltatás:

Front Door Service

API-verzió:

2025-04-15

Lekér egy meglévő AzureFrontDoor-tartományt a megadott előfizetés, erőforráscsoport és profil alatt megadott tartománynévvel.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
customDomainName	path	True	string	A profil alatti tartomány neve, amely globálisan egyedi.
profileName	path	True	string minLength: 1 maxLength: 260 pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$	Az Azure Front Door Standard vagy az Azure Front Door Premium neve, amely egyedi az erőforráscsoporton belül.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Az Azure-előfizetés erőforráscsoportjának neve.
subscriptionId	path	True	string	Azure-előfizetés azonosítója.
api-version	query	True	string	Az ügyfélkéréshez használandó API verziója. A jelenlegi verzió: 2025-04-15.

Válaszok

Name	Típus	Description
200 OK	AFDDomain	OKÉ
Other Status Codes	AfdErrorResponse	Az Azure Front Door hibaválasza, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

AFDCustomDomains_Get

Mintakérelem

HTTP

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

Mintaválasz

Állapotkó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"
  }
}

Definíciók

Name	Description
AfdCertificateType	Meghatározza az SSL-tanúsítvány forrását.
AfdCipherSuiteSetType	A Https-hez használt titkosítási csomagkészlet típusa
AfdCustomizedCipherSuiteForTls12	Titkosítási csomagok a TLS 1.2-hez. Legalább egy szükséges a minimumTlsVersion TLS 1.2-ben.
AfdCustomizedCipherSuiteForTls13	Titkosítási csomagok a TLS 1.3-hoz. Legalább egy szükséges a minimumTlsVersion TLS 1.2-ben és a TLS 1.3-ban.
AFDDomain	Felhasználóbarát tartománynév-hozzárendelés az ügyfél által márkaépítési célokra megadott végponti állomásnévhez, pl. www.contoso.com.
AFDDomainHttpsCustomizedCipherSuiteSet	A Https-hez a cipherSuiteSetType testreszabásakor használt testreszabott titkosítási csomag-objektum.
AFDDomainHttpsParameters	A tartomány biztonságossá tételéhez használt tulajdonságokat tartalmazó JSON-objektum.
AfdErrorResponse	Hibaválasz
AfdMinimumTlsVersion	A Https-hez használt TLS protokollverzió, ha a cipherSuiteSetType testre van szabva.
AfdProvisioningState	Kiépítés állapota
DeploymentStatus
DomainValidationProperties	A tartomány érvényesítéséhez szükséges tulajdonságokat tartalmazó JSON-objektum.
DomainValidationState	A kiépítési alállapot lépésről lépésre mutatja az egyéni HTTPS engedélyezésének/letiltásának folyamatát. A DCV a DomainControlValidation rövidítése.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
IdentityType	Az erőforrásokat létrehozó/módosító identitás típusa
ResourceReference	Hivatkozás egy másik erőforrásra.
SystemData	Csak olvasási rendszeradatok

AfdCertificateType

Enumerálás

Meghatározza az SSL-tanúsítvány forrását.

Érték	Description
CustomerCertificate
ManagedCertificate
AzureFirstPartyManagedCertificate

AfdCipherSuiteSetType

Enumerálás

A Https-hez használt titkosítási csomagkészlet típusa

Érték	Description
Customized
TLS10_2019
TLS12_2022
TLS12_2023

AfdCustomizedCipherSuiteForTls12

Enumerálás

Titkosítási csomagok a TLS 1.2-hez. Legalább egy szükséges a minimumTlsVersion TLS 1.2-ben.

Érték	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

Enumerálás

Titkosítási csomagok a TLS 1.3-hoz. Legalább egy szükséges a minimumTlsVersion TLS 1.2-ben és a TLS 1.3-ban.

Érték	Description
TLS_AES_128_GCM_SHA256
TLS_AES_256_GCM_SHA384

AFDDomain

Objektum

Felhasználóbarát tartománynév-hozzárendelés az ügyfél által márkaépítési célokra megadott végponti állomásnévhez, pl. www.contoso.com.

Name	Típus	Description
id	string	Erőforrás-azonosító.
name	string	Erőforrás neve.
properties.azureDnsZone	ResourceReference	Erőforrás-hivatkozás az Azure DNS-zónára
properties.deploymentStatus	DeploymentStatus
properties.domainValidationState	DomainValidationState	A kiépítési alállapot lépésről lépésre mutatja az egyéni HTTPS engedélyezésének/letiltásának folyamatát. A DCV a DomainControlValidation rövidítése.
properties.extendedProperties	object	Key-Value tartományok áttelepítési tulajdonságait képviselő pár.
properties.hostName	string	A tartomány állomásneve. Tartománynévnek kell lennie.
properties.preValidatedCustomDomainResourceId	ResourceReference	Erőforrás-hivatkozás arra az Azure-erőforrásra, ahol az egyéni tartomány tulajdonjoga előre meg volt találták
properties.profileName	string	A tartományt tartalmazó profil neve.
properties.provisioningState	AfdProvisioningState	Kiépítés állapota
properties.tlsSettings	AFDDomainHttpsParameters	A HTTPS tartományhoz való engedélyezését meghatározó konfiguráció – az AzureFrontDoor által felügyelt tanúsítvány vagy a felhasználó saját tanúsítványának használatával. Ha nincs megadva, az SSL engedélyezése alapértelmezés szerint AzureFrontDoor által felügyelt tanúsítványt használ.
properties.validationProperties	DomainValidationProperties	Értékek, amelyekre az ügyfélnek szüksége van a tartomány tulajdonjogának ellenőrzésére
systemData	SystemData	Csak olvasási rendszeradatok
type	string	Erőforrás típusa.

AFDDomainHttpsCustomizedCipherSuiteSet

Objektum

A Https-hez a cipherSuiteSetType testreszabásakor használt testreszabott titkosítási csomag-objektum.

Name	Típus	Description
cipherSuiteSetForTls12	AfdCustomizedCipherSuiteForTls12[]	Titkosítási csomagok a TLS 1.2-hez. Legalább egy szükséges a minimumTlsVersion TLS 1.2-ben.
cipherSuiteSetForTls13	AfdCustomizedCipherSuiteForTls13[]	Titkosítási csomagok a TLS 1.3-hoz. Legalább egy szükséges a minimumTlsVersion TLS 1.2-ben és a TLS 1.3-ban.

AFDDomainHttpsParameters

Objektum

A tartomány biztonságossá tételéhez használt tulajdonságokat tartalmazó JSON-objektum.

Name	Típus	Description
certificateType	AfdCertificateType	Meghatározza az SSL-tanúsítvány forrását.
cipherSuiteSetType	AfdCipherSuiteSetType	A Https-hez használt titkosítási csomagkészlet típusa
customizedCipherSuiteSet	AFDDomainHttpsCustomizedCipherSuiteSet	A Https-hez használt testreszabott titkosítási csomagok objektuma, ha a cipherSuiteSetType testre van szabva.
minimumTlsVersion	AfdMinimumTlsVersion	A Https-hez használt TLS protokollverzió, ha a cipherSuiteSetType testre van szabva.
secret	ResourceReference	Erőforrás-hivatkozás a titkos kódra. Ie. subs/rg/profile/secret

AfdErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

AfdMinimumTlsVersion

Enumerálás

A Https-hez használt TLS protokollverzió, ha a cipherSuiteSetType testre van szabva.

Érték	Description
TLS10
TLS12
TLS13

AfdProvisioningState

Enumerálás

Kiépítés állapota

Érték	Description
Succeeded
Failed
Updating
Deleting
Creating

DeploymentStatus

Enumerálás

Érték	Description
NotStarted
InProgress
Succeeded
Failed

DomainValidationProperties

Objektum

A tartomány érvényesítéséhez szükséges tulajdonságokat tartalmazó JSON-objektum.

Name	Típus	Description
expirationDate	string	A jogkivonat lejáratának dátuma
validationToken	string	A DNS TXT rekordhoz vagy fájlalapú ellenőrzéshez használt kihívás

DomainValidationState

Enumerálás

A kiépítési alállapot lépésről lépésre mutatja az egyéni HTTPS engedélyezésének/letiltásának folyamatát. A DCV a DomainControlValidation rövidítése.

Érték	Description
Unknown
Submitting
Pending
Rejected
TimedOut
PendingRevalidation
Approved
RefreshingValidationToken
InternalError

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

IdentityType

Enumerálás

Az erőforrásokat létrehozó/módosító identitás típusa

Érték	Description
user
application
managedIdentity
key

ResourceReference

Objektum

Hivatkozás egy másik erőforrásra.

Name	Típus	Description
id	string	Erőforrás-azonosító.

SystemData

Objektum

Csak olvasási rendszeradatok

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC)
createdBy	string	Az erőforrást létrehozó identitás azonosítója
createdByType	IdentityType	Az erőforrást létrehozó identitás típusa
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás azonosítója
lastModifiedByType	IdentityType	Az erőforrást legutóbb módosító identitás típusa