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

Secrets - List By Profile

参考

服务:: Front Door Service

API 版本:: 2025-04-15

列出现有的 AzureFrontDoor 机密。

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

URI 参数

名称	在	必需	类型	说明
profileName	path	True	string minLength: 1 maxLength: 260 pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9])$	在资源组中唯一的 Azure Front Door 标准版或 Azure Front Door Premium 的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Azure 订阅中的资源组的名称。
subscriptionId	path	True	string	Azure 订阅 ID。
api-version	query	True	string	要用于客户端请求的 API 的版本。当前版本为 2025-04-15。

响应

名称	类型	说明
200 OK	SecretListResult	还行
Other Status Codes	AfdErrorResponse	Azure Front Door 错误响应，描述作失败的原因。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Secrets_ListByProfile

示例请求

HTTP

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

示例响应

状态代码:: 200

{
  "value": [
    {
      "name": "secret1",
      "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1",
      "type": "Microsoft.Cdn/profiles/secrets",
      "properties": {
        "parameters": {
          "type": "CustomerCertificate",
          "subject": "*.contoso.com",
          "certificateAuthority": "Symantec",
          "expirationDate": "2025-01-01T00:00:00-00:00",
          "thumbprint": "ABCDEF1234567890ABCDEF1234567890ABCDEF12",
          "secretSource": {
            "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.KeyVault/vaults/keyvaultname/secrets/certificatename"
          },
          "secretVersion": "abcdef1234578900abcdef1234567890",
          "useLatestVersion": true,
          "subjectAlternativeNames": [
            "foo.contoso.com",
            "www3.foo.contoso.com"
          ]
        },
        "provisioningState": "Succeeded",
        "deploymentStatus": "NotStarted"
      }
    },
    {
      "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/autogenerated_secret_name",
      "type": "Microsoft.Cdn/profiles/secrets",
      "name": "69f05517-6aaf-4a1e-a96d-f8c02f66c756-test12-afdx-test-domains-azfdtest-xyz",
      "properties": {
        "parameters": {
          "type": "ManagedCertificate",
          "subject": "bar.contoso.com",
          "expirationDate": "2025-01-01T00:00:00-00:00"
        },
        "provisioningState": "Succeeded",
        "deploymentStatus": "NotStarted"
      }
    }
  ]
}

定义

名称	说明
AfdErrorResponse	错误响应
AfdProvisioningState	预配状态
AzureFirstPartyManagedCertificateParameters	其他第一方资源提供程序提供的 Azure FirstParty 托管证书，用于启用 HTTPS。
CustomerCertificateParameters	用于 https 的客户证书
DeploymentStatus
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
IdentityType	创建/修改资源的标识类型
ManagedCertificateParameters	用于 https 的托管证书
ResourceReference	对另一个资源的引用。
Secret	友好机密名称映射到任何机密或机密相关信息。
SecretListResult	列出机密的请求的结果。它包含机密对象列表和 URL 链接，用于获取下一组结果。
SecretType	The type of the secret resource.
SystemData	只读系统数据
UrlSigningKeyParameters	URL 签名密钥参数

AfdErrorResponse

Object

错误响应

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

AfdProvisioningState

枚举

预配状态

值	说明
Creating
Deleting
Failed
Succeeded
Updating

AzureFirstPartyManagedCertificateParameters

Object

其他第一方资源提供程序提供的 Azure FirstParty 托管证书，用于启用 HTTPS。

名称	类型	说明
certificateAuthority	string	Certificate issuing authority.
expirationDate	string	证书到期日期。
secretSource	ResourceReference	Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}
subject	string	证书中的使用者名称。
subjectAlternativeNames	string[]	The list of SANs.
thumbprint	string	Certificate thumbprint.
type	string: AzureFirstPartyManagedCertificate	The type of the secret resource.

CustomerCertificateParameters

Object

用于 https 的客户证书

名称	类型	说明
certificateAuthority	string	Certificate issuing authority.
expirationDate	string	证书到期日期。
secretSource	ResourceReference	Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName}
secretVersion	string	Version of the secret to be used
subject	string	证书中的使用者名称。
subjectAlternativeNames	string[]	The list of SANs.
thumbprint	string	Certificate thumbprint.
type	string: CustomerCertificate	The type of the secret resource.
useLatestVersion	boolean	Whether to use the latest version for the certificate

DeploymentStatus

枚举

值	说明
Failed
InProgress
NotStarted
Succeeded

ErrorAdditionalInfo

Object

资源管理错误附加信息。

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

ErrorDetail

Object

错误详细信息。

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

IdentityType

枚举

创建/修改资源的标识类型

值	说明
application
key
managedIdentity
user

ManagedCertificateParameters

Object

用于 https 的托管证书

名称	类型	说明
expirationDate	string	证书到期日期。
subject	string	证书中的使用者名称。
type	string: ManagedCertificate	The type of the secret resource.

ResourceReference

Object

对另一个资源的引用。

名称	类型	说明
id	string	Resource ID.

Secret

Object

友好机密名称映射到任何机密或机密相关信息。

名称	类型	说明
id	string	Resource ID.
name	string	Resource name.
properties.deploymentStatus	DeploymentStatus
properties.parameters	SecretParameters: AzureFirstPartyManagedCertificateParameters CustomerCertificateParameters ManagedCertificateParameters UrlSigningKeyParameters	object which contains secret parameters
properties.profileName	string	保存机密的配置文件的名称。
properties.provisioningState	AfdProvisioningState	预配状态
systemData	SystemData	只读系统数据
type	string	资源类型。

SecretListResult

Object

列出机密的请求的结果。它包含机密对象列表和 URL 链接，用于获取下一组结果。

名称	类型	说明
nextLink	string	用于获取下一组机密对象的 URL（如果有）。
value	Secret[]	配置文件中的 AzureFrontDoor 机密列表。

SecretType

枚举

The type of the secret resource.

值	说明
AzureFirstPartyManagedCertificate
CustomerCertificate
ManagedCertificate
UrlSigningKey

SystemData

Object

只读系统数据

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）
createdBy	string	创建资源的标识的标识符
createdByType	IdentityType	创建资源的标识类型
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识的标识符
lastModifiedByType	IdentityType	上次修改资源的标识类型

UrlSigningKeyParameters

Object

URL 签名密钥参数

名称	类型	说明
keyId	string	Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash.
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}
secretVersion	string	Version of the secret to be used
type	string: UrlSigningKey	The type of the secret resource.

通过

Secrets - List By Profile

URI 参数

响应

安全性

azure_auth

作用域

示例

Secrets_ListByProfile

示例请求

示例响应

定义

AfdErrorResponse

AfdProvisioningState

AzureFirstPartyManagedCertificateParameters

CustomerCertificateParameters

DeploymentStatus

ErrorAdditionalInfo

ErrorDetail

IdentityType

ManagedCertificateParameters

ResourceReference

Secret

SecretListResult

SecretType

SystemData

UrlSigningKeyParameters