你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

AFD Profiles - Validate Secret

参考

Service:: Front Door Service

API Version:: 2023-05-01

验证配置文件中的机密。

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

URI 参数

名称	在	必需	类型	说明
profileName	path	True	string	资源组中唯一的 Azure Front Door Standard 或 Azure Front Door Premium 的名称。 Regex pattern: `^[a-zA-Z0-9]+(-[a-zA-Z0-9])$`
resourceGroupName	path	True	string	Azure 订阅中的资源组的名称。 Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	Azure 订阅 ID。
api-version	query	True	string	要与客户端请求一起使用的 API 的版本。当前版本为 2023-05-01。

请求正文

名称	必需	类型	说明
secretSource	True	ResourceReference	Azure 密钥保管库机密的资源引用。应采用 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName} 的格式
secretType	True	SecretType	机密类型。
secretVersion		string	机密版本（如果客户使用的是特定版本）。

响应

名称	类型	说明
200 OK	ValidateSecretOutput	确定
Other Status Codes	AfdErrorResponse	描述操作失败原因的 Azure Front Door 错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

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
}

定义

名称	说明
AfdErrorResponse	错误响应
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ResourceReference	对另一个资源的引用。
SecretType	机密资源的类型。
status	验证状态。
ValidateSecretInput	要验证的机密的输入。
ValidateSecretOutput	已验证机密的输出。

AfdErrorResponse

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ResourceReference

对另一个资源的引用。

名称	类型	说明
id	string	资源 ID。

SecretType

机密资源的类型。

名称	类型	说明
AzureFirstPartyManagedCertificate	string
CustomerCertificate	string
ManagedCertificate	string
UrlSigningKey	string

status

验证状态。

名称	类型	说明
AccessDenied	string
CertificateExpired	string
Invalid	string
Valid	string

ValidateSecretInput

要验证的机密的输入。

名称	类型	说明
secretSource	ResourceReference	Azure 密钥保管库机密的资源引用。应采用 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName} 的格式
secretType	SecretType	机密类型。
secretVersion	string	机密版本（如果客户使用的是特定版本）。

ValidateSecretOutput

已验证机密的输出。

名称	类型	说明
message	string	详细错误消息
status	status	验证状态。

Share via

AFD Profiles - Validate Secret

URI 参数

请求正文

响应

安全性

azure_auth

Scopes

示例

Validate_Secret

Sample Request

Sample Response

定义

AfdErrorResponse

ErrorAdditionalInfo

ErrorDetail

ResourceReference

SecretType

status

ValidateSecretInput

ValidateSecretOutput

其他资源