AFD Profiles - Validate Secret

Tjänst:

Front Door Service

API-version:

2025-04-15

Verifiera en hemlighet i profilen.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
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.

Begärandetext

Name	Obligatorisk	Typ	Description
secretSource	True	ResourceReference	Resursreferens till Azure Key Vault-hemligheten. Förväntas vara i formatet /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}
secretType	True	SecretType	Den hemliga typen.
secretVersion		string	Hemlig version, om kunden använder en viss version.

Svar

Name	Typ	Description
200 OK	ValidateSecretOutput	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

Validate_Secret

Exempelbegäran

HTTP

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

{
  "secretSource": {
    "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/certificate/certName"
  },
  "secretType": "CustomerCertificate"
}

Exempelsvar

Statuskod:

200

{
  "status": "Valid",
  "message": null
}

Definitioner

Name	Description
AfdErrorResponse	Felsvar
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ResourceReference	Referens till en annan resurs.
SecretType	Typ av hemlig resurs.
status	Valideringsstatus.
ValidateSecretInput	Indata för hemligheten som ska verifieras.
ValidateSecretOutput	Utdata från den verifierade hemligheten.

AfdErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

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.

ResourceReference

Objekt

Referens till en annan resurs.

Name	Typ	Description
id	string	Resurs-ID.

SecretType

Uppräkning

Typ av hemlig resurs.

Värde	Description
UrlSigningKey
CustomerCertificate
ManagedCertificate
AzureFirstPartyManagedCertificate

status

Uppräkning

Valideringsstatus.

Värde	Description
Valid
Invalid
AccessDenied
CertificateExpired

ValidateSecretInput

Objekt

Indata för hemligheten som ska verifieras.

Name	Typ	Description
secretSource	ResourceReference	Resursreferens till Azure Key Vault-hemligheten. Förväntas vara i formatet /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}
secretType	SecretType	Den hemliga typen.
secretVersion	string	Hemlig version, om kunden använder en viss version.

ValidateSecretOutput

Objekt

Utdata från den verifierade hemligheten.

Name	Typ	Description
message	string	Detaljerat felmeddelande
status	status	Valideringsstatus.