AFD Profiles - Validate Secret

Service:

Front Door Service

Version d'API:

2025-04-15

Validez un secret dans le profil.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
profileName	path	True	string minLength: 1 maxLength: 260 pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$	Nom d’Azure Front Door Standard ou d’Azure Front Door Premium qui est unique dans le groupe de ressources.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
secretSource	True	ResourceReference	Référence de ressource au secret Azure Key Vault. Doit être au format /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}
secretType	True	SecretType	Type de secret.
secretVersion		string	Version secrète, si le client utilise une version spécifique.

Réponses

Nom	Type	Description
200 OK	ValidateSecretOutput	Ok
Other Status Codes	ErrorResponse	Réponse d’erreur Azure Front Door décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Validate_Secret

Exemple de requête

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/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"
}

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Cdn.Models;
using Azure.ResourceManager.Resources.Models;
using Azure.ResourceManager.Cdn;

// Generated from example definition: specification/cdn/resource-manager/Microsoft.Cdn/stable/2025-04-15/examples/AFDProfiles_ValidateSecret.json
// this example is just showing the usage of "FrontDoorProfiles_ValidateSecret" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ProfileResource created on azure
// for more information of creating ProfileResource, please refer to the document of ProfileResource
string subscriptionId = "subid";
string resourceGroupName = "RG";
string profileName = "profile1";
ResourceIdentifier profileResourceId = ProfileResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName);
ProfileResource profile = client.GetProfileResource(profileResourceId);

// invoke the operation
ValidateSecretContent content = new ValidateSecretContent(SecretType.CustomerCertificate, new WritableSubResource
{
    Id = new ResourceIdentifier("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/certificate/certName"),
});
ValidateSecretResult result = await profile.ValidateSecretFrontDoorProfileAsync(content);

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:

200

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

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
ResourceReference	Référence à une autre ressource.
SecretType	Type de la ressource secrète.
status	État de validation.
ValidateSecretInput	Entrée du secret à valider.
ValidateSecretOutput	Sortie du secret validé.

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

ResourceReference

Object

Référence à une autre ressource.

Nom	Type	Description
id	string	ID de ressource.

SecretType

Énumération

Type de la ressource secrète.

Valeur	Description
AzureFirstPartyManagedCertificate
CustomerCertificate
ManagedCertificate
UrlSigningKey

status

Énumération

État de validation.

Valeur	Description
AccessDenied
CertificateExpired
Invalid
Valid

ValidateSecretInput

Object

Entrée du secret à valider.

Nom	Type	Description
secretSource	ResourceReference	Référence de ressource au secret Azure Key Vault. Doit être au format /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}
secretType	SecretType	Type de secret.
secretVersion	string	Version secrète, si le client utilise une version spécifique.

ValidateSecretOutput

Object

Sortie du secret validé.

Nom	Type	Description
message	string	Messages d’erreur détaillés
status	status	État de validation.