AFD Profiles - Validate Secret

Service:

Front Door Service

API-versie:

2025-04-15

Valideer een geheim in het profiel.

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

URI-parameters

Name	In	Vereist	Type	Description
profileName	path	True	string minLength: 1 maxLength: 260 pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$	De naam van de Azure Front Door Standard of Azure Front Door Premium die uniek is binnen de resourcegroep.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
secretSource	True	ResourceReference	Resourceverwijzing naar het Azure Key Vault-geheim. Verwacht moet de indeling /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName} hebben
secretType	True	SecretType	Het geheime type.
secretVersion		string	Geheime versie, als de klant een specifieke versie gebruikt.

Antwoorden

Name	Type	Description
200 OK	ValidateSecretOutput	OK
Other Status Codes	ErrorResponse	Azure Front Door-foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Validate_Secret

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

200

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

Definities

Name	Description
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
ResourceReference	Verwijzing naar een andere resource.
SecretType	Het type geheime resource.
status	De validatiestatus.
ValidateSecretInput	Invoer van het geheim dat moet worden gevalideerd.
ValidateSecretOutput	Uitvoer van het gevalideerde geheim.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

ResourceReference

Object

Verwijzing naar een andere resource.

Name	Type	Description
id	string	Resource-id.

SecretType

Inventarisatie

Het type geheime resource.

Waarde	Description
AzureFirstPartyManagedCertificate
CustomerCertificate
ManagedCertificate
UrlSigningKey

status

Inventarisatie

De validatiestatus.

Waarde	Description
AccessDenied
CertificateExpired
Invalid
Valid

ValidateSecretInput

Object

Invoer van het geheim dat moet worden gevalideerd.

Name	Type	Description
secretSource	ResourceReference	Resourceverwijzing naar het Azure Key Vault-geheim. Verwacht moet de indeling /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName} hebben
secretType	SecretType	Het geheime type.
secretVersion	string	Geheime versie, als de klant een specifieke versie gebruikt.

ValidateSecretOutput

Object

Uitvoer van het gevalideerde geheim.

Name	Type	Description
message	string	Gedetailleerd foutbericht
status	status	De validatiestatus.