AFD Profiles - Validate Secret

Reference

Service:: Front Door Service

API Version:: 2023-05-01

Validate a Secret in the profile.

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

URI Parameters

Name	In	Required	Type	Description
profileName	path	True	string	Name of the Azure Front Door Standard or Azure Front Door Premium which is unique within the resource group. Regex pattern: `^[a-zA-Z0-9]+(-[a-zA-Z0-9])$`
resourceGroupName	path	True	string	Name of the Resource group within the Azure subscription. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Azure Subscription ID.
api-version	query	True	string	Version of the API to be used with the client request. Current version is 2023-05-01.

Request Body

Name	Required	Type	Description
secretSource	True	ResourceReference	Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}
secretType	True	SecretType	The secret type.
secretVersion		string	Secret version, if customer is using a specific version.

Responses

Name	Type	Description
200 OK	ValidateSecretOutput	OK
Other Status Codes	AfdErrorResponse	Azure Front Door error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Validate_Secret

Sample Request

POST https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/validateSecret?api-version=2023-05-01

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


import com.azure.resourcemanager.cdn.models.ResourceReference;
import com.azure.resourcemanager.cdn.models.SecretType;
import com.azure.resourcemanager.cdn.models.ValidateSecretInput;

/** Samples for AfdProfiles ValidateSecret. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/AFDProfiles_ValidateSecret.json
     */
    /**
     * Sample code: Validate_Secret.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void validateSecret(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getAfdProfiles().validateSecretWithResponse("RG", "profile1",
            new ValidateSecretInput().withSecretType(SecretType.CUSTOMER_CERTIFICATE)
                .withSecretSource(new ResourceReference().withId(
                    "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/certificate/certName")),
            com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential
from azure.mgmt.cdn import CdnManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cdn
# USAGE
    python afd_profiles_validate_secret.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CdnManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.afd_profiles.validate_secret(
        resource_group_name="RG",
        profile_name="profile1",
        validate_secret_input={
            "secretSource": {
                "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/certificate/certName"
            },
            "secretType": "CustomerCertificate",
        },
    )
    print(response)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/AFDProfiles_ValidateSecret.json
if __name__ == "__main__":
    main()

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

package armcdn_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cdn/armcdn/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7b551033155a63739b6d28f79b9c07569f6179b8/specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/AFDProfiles_ValidateSecret.json
func ExampleAFDProfilesClient_ValidateSecret() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcdn.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAFDProfilesClient().ValidateSecret(ctx, "RG", "profile1", armcdn.ValidateSecretInput{
		SecretSource: &armcdn.ResourceReference{
			ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/certificate/certName"),
		},
		SecretType: to.Ptr(armcdn.SecretTypeCustomerCertificate),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ValidateSecretOutput = armcdn.ValidateSecretOutput{
	// 	Status: to.Ptr(armcdn.StatusValid),
	// }
}

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

const { CdnManagementClient } = require("@azure/arm-cdn");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Validate a Secret in the profile.
 *
 * @summary Validate a Secret in the profile.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/AFDProfiles_ValidateSecret.json
 */
async function validateSecret() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const profileName = "profile1";
  const validateSecretInput = {
    secretSource: {
      id: "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vault/kvName/certificate/certName",
    },
    secretType: "CustomerCertificate",
  };
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.afdProfiles.validateSecret(
    resourceGroupName,
    profileName,
    validateSecretInput
  );
  console.log(result);
}

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

Sample Response

Status code:: 200

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

Definitions

Name	Description
AfdErrorResponse	Error response
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ResourceReference	Reference to another resource.
SecretType	The type of the secret resource.
status	The validation status.
ValidateSecretInput	Input of the secret to be validated.
ValidateSecretOutput	Output of the validated secret.

AfdErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ResourceReference

Reference to another resource.

Name	Type	Description
id	string	Resource ID.

SecretType

The type of the secret resource.

Name	Type	Description
AzureFirstPartyManagedCertificate	string
CustomerCertificate	string
ManagedCertificate	string
UrlSigningKey	string

status

The validation status.

Name	Type	Description
AccessDenied	string
CertificateExpired	string
Invalid	string
Valid	string

ValidateSecretInput

Input of the secret to be validated.

Name	Type	Description
secretSource	ResourceReference	Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName}
secretType	SecretType	The secret type.
secretVersion	string	Secret version, if customer is using a specific version.

ValidateSecretOutput

Output of the validated secret.

Name	Type	Description
message	string	Detailed error message
status	status	The validation status.

AFD Profiles - Validate Secret

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Validate_Secret

Sample Request

Sample Response

Definitions

AfdErrorResponse

ErrorAdditionalInfo

ErrorDetail

ResourceReference

SecretType

status

ValidateSecretInput

ValidateSecretOutput

Additional resources