AFD Custom Domains - Get

Tjänst:: Front Door Service

API-version:: 2025-04-15

Hämtar en befintlig AzureFrontDoor-domän med det angivna domännamnet under den angivna prenumerationen, resursgruppen och profilen.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
customDomainName	path	True	string	Namnet på domänen under profilen som är unik globalt.
profileName	path	True	string minLength: 1 maxLength: 260 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9])$	Namnet på Azure Front Door Standard eller Azure Front Door Premium som är unikt i resursgruppen.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Namnet på resursgruppen i Azure-prenumerationen.
subscriptionId	path	True	string	Azure-prenumerations-ID.
api-version	query	True	string	Version av API:et som ska användas med klientbegäran. Den aktuella versionen är 2025-04-15.

Svar

Name	Typ	Description
200 OK	AFDDomain	OKEJ
Other Status Codes	AfdErrorResponse	Azure Front Door-felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

AFDCustomDomains_Get

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 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"
  }
}

Definitioner

Name	Description
AfdCertificateType	Definierar källan till SSL-certifikatet.
AfdCipherSuiteSetType	typ av chiffersvituppsättning som ska användas för Https
AfdCustomizedCipherSuiteForTls12	Chiffersviter för TLS 1.2. Krävs minst en i minimumTlsVersion TLS 1.2.
AfdCustomizedCipherSuiteForTls13	Chiffersviter för TLS 1.3. Krävs minst en i minimumTlsVersion TLS 1.2, TLS 1.3.
AFDDomain	Egen domännamnsmappning till slutpunktens värdnamn som kunden tillhandahåller i varumärkessyfte, t.ex. `www.contoso.com`
AFDDomainHttpsCustomizedCipherSuiteSet	Anpassat chifferpaketuppsättningsobjekt som ska användas för Https när chifferSuiteSetType är anpassat.
AFDDomainHttpsParameters	JSON-objektet som innehåller egenskaperna för att skydda en domän.
AfdErrorResponse	Felsvar
AfdMinimumTlsVersion	TLS-protokollversion som ska användas för Https när chifferSuiteSetType är Anpassad.
AfdProvisioningState	Etableringsstatus
DeploymentStatus
DomainValidationProperties	JSON-objektet som innehåller egenskaperna för att verifiera en domän.
DomainValidationState	Etableringsundertillstånd visar förloppet för den anpassade HTTPS-aktiverings-/inaktiveringsprocessen steg för steg. DCV står för DomainControlValidation.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
IdentityType	Den typ av identitet som skapar/ändrar resurser
ResourceReference	Referens till en annan resurs.
SystemData	Skrivskyddade systemdata

AfdCertificateType

Uppräkning

Definierar källan till SSL-certifikatet.

Värde	Description
CustomerCertificate
ManagedCertificate
AzureFirstPartyManagedCertificate

AfdCipherSuiteSetType

Uppräkning

typ av chiffersvituppsättning som ska användas för Https

Värde	Description
Customized
TLS10_2019
TLS12_2022
TLS12_2023

AfdCustomizedCipherSuiteForTls12

Uppräkning

Chiffersviter för TLS 1.2. Krävs minst en i minimumTlsVersion TLS 1.2.

Värde	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

Uppräkning

Chiffersviter för TLS 1.3. Krävs minst en i minimumTlsVersion TLS 1.2, TLS 1.3.

Värde	Description
TLS_AES_128_GCM_SHA256
TLS_AES_256_GCM_SHA384

AFDDomain

Objekt

Egen domännamnsmappning till slutpunktens värdnamn som kunden tillhandahåller i varumärkessyfte, t.ex. www.contoso.com

Name	Typ	Description
id	string	Resurs-ID.
name	string	Resursnamn.
properties.azureDnsZone	ResourceReference	Resursreferens till Azure DNS-zonen
properties.deploymentStatus	DeploymentStatus
properties.domainValidationState	DomainValidationState	Etableringsundertillstånd visar förloppet för den anpassade HTTPS-aktiverings-/inaktiveringsprocessen steg för steg. DCV står för DomainControlValidation.
properties.extendedProperties	object	Key-Value par som representerar migreringsegenskaper för domäner.
properties.hostName	string	Domänens värdnamn. Måste vara ett domännamn.
properties.preValidatedCustomDomainResourceId	ResourceReference	Resursreferens till Azure-resursen där det anpassade domänägarskapet var förvaliderat
properties.profileName	string	Namnet på den profil som innehåller domänen.
properties.provisioningState	AfdProvisioningState	Etableringsstatus
properties.tlsSettings	AFDDomainHttpsParameters	Konfigurationen som anger hur du aktiverar HTTPS för domänen – med azureFrontDoor-hanterat certifikat eller användarens eget certifikat. Om det inte anges använder aktivering av ssl AzureFrontDoor-hanterat certifikat som standard.
properties.validationProperties	DomainValidationProperties	Värden som kunden behöver för att verifiera domänägarskapet
systemData	SystemData	Skrivskyddade systemdata
type	string	Resurstyp.

AFDDomainHttpsCustomizedCipherSuiteSet

Objekt

Anpassat chifferpaketuppsättningsobjekt som ska användas för Https när chifferSuiteSetType är anpassat.

Name	Typ	Description
cipherSuiteSetForTls12	AfdCustomizedCipherSuiteForTls12[]	Chiffersviter för TLS 1.2. Krävs minst en i minimumTlsVersion TLS 1.2.
cipherSuiteSetForTls13	AfdCustomizedCipherSuiteForTls13[]	Chiffersviter för TLS 1.3. Krävs minst en i minimumTlsVersion TLS 1.2, TLS 1.3.

AFDDomainHttpsParameters

Objekt

JSON-objektet som innehåller egenskaperna för att skydda en domän.

Name	Typ	Description
certificateType	AfdCertificateType	Definierar källan till SSL-certifikatet.
cipherSuiteSetType	AfdCipherSuiteSetType	typ av chiffersvituppsättning som ska användas för Https
customizedCipherSuiteSet	AFDDomainHttpsCustomizedCipherSuiteSet	Anpassat chiffersvitobjekt som ska användas för Https när chifferSuiteSetType är anpassat.
minimumTlsVersion	AfdMinimumTlsVersion	TLS-protokollversion som ska användas för Https när chifferSuiteSetType är Anpassad.
secret	ResourceReference	Resursreferens till hemligheten. ie. subs/rg/profile/secret

AfdErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

AfdMinimumTlsVersion

Uppräkning

TLS-protokollversion som ska användas för Https när chifferSuiteSetType är Anpassad.

Värde	Description
TLS10
TLS12
TLS13

AfdProvisioningState

Uppräkning

Etableringsstatus

Värde	Description
Succeeded
Failed
Updating
Deleting
Creating

DeploymentStatus

Uppräkning

Värde	Description
NotStarted
InProgress
Succeeded
Failed

DomainValidationProperties

Objekt

JSON-objektet som innehåller egenskaperna för att verifiera en domän.

Name	Typ	Description
expirationDate	string	Datum då token upphör att gälla
validationToken	string	Utmaning som används för DNS TXT-post eller filbaserad validering

DomainValidationState

Uppräkning

Etableringsundertillstånd visar förloppet för den anpassade HTTPS-aktiverings-/inaktiveringsprocessen steg för steg. DCV står för DomainControlValidation.

Värde	Description
Unknown
Submitting
Pending
Rejected
TimedOut
PendingRevalidation
Approved
RefreshingValidationToken
InternalError

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

IdentityType

Uppräkning

Den typ av identitet som skapar/ändrar resurser

Värde	Description
user
application
managedIdentity
key

ResourceReference

Objekt

Referens till en annan resurs.

Name	Typ	Description
id	string	Resurs-ID.

SystemData

Objekt

Skrivskyddade systemdata

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC)
createdBy	string	En identifierare för den identitet som skapade resursen
createdByType	IdentityType	Den typ av identitet som skapade resursen
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	En identifierare för den identitet som senast ändrade resursen
lastModifiedByType	IdentityType	Den typ av identitet som senast ändrade resursen

Dela via

AFD Custom Domains - Get

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

AFDCustomDomains_Get

Exempelbegäran

Exempelsvar

Definitioner

AfdCertificateType

AfdCipherSuiteSetType

AfdCustomizedCipherSuiteForTls12

AfdCustomizedCipherSuiteForTls13

AFDDomain

AFDDomainHttpsCustomizedCipherSuiteSet

AFDDomainHttpsParameters

AfdErrorResponse

AfdMinimumTlsVersion

AfdProvisioningState

DeploymentStatus

DomainValidationProperties

DomainValidationState

ErrorAdditionalInfo

ErrorDetail

IdentityType

ResourceReference

SystemData