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

Secrets - Get

获取配置文件中的现有机密。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/secrets/{secretName}?api-version=2021-06-01

URI 参数

Name In Required Type Description
profileName
path True
  • string

Azure Front Door Standard 或 Azure Front Door 高级版配置文件的名称,该配置文件在资源组中是唯一的。

resourceGroupName
path True
  • string

Azure 订阅中的资源组的名称。

Regex pattern: ^[-\w\._\(\)]+$

secretName
path True
  • string

配置文件下机密的名称。

subscriptionId
path True
  • string

Azure 订阅 ID。

api-version
query True
  • string

要与客户端请求一起使用的 API 版本。 当前版本为 2021-06-01。

响应

Name Type Description
200 OK

确定

Other Status Codes

CDN错误响应,描述操作失败的原因。

安全性

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 模拟用户帐户

示例

Secrets_Get

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/secrets/secret1?api-version=2021-06-01

Sample Response

{
  "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"
  }
}

定义

AfdErrorResponse

错误响应

AfdProvisioningState

预配状态

AzureFirstPartyManagedCertificateParameters

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

CustomerCertificateParameters

用于 https 的客户证书

DeploymentStatus
ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

IdentityType

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

ManagedCertificateParameters

用于 https 的托管证书

ResourceReference

对另一个资源的引用。

Secret

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

SecretType

机密资源的类型。

SystemData

只读系统数据

UrlSigningKeyParameters

URL 签名密钥参数

AfdErrorResponse

错误响应

Name Type Description
error

错误对象。

AfdProvisioningState

预配状态

Name Type Description
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

AzureFirstPartyManagedCertificateParameters

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

Name Type Description
type string:
  • AzureFirstPartyManagedCertificate

机密资源的类型。

CustomerCertificateParameters

用于 https 的客户证书

Name Type Description
certificateAuthority
  • string

证书颁发机构。

expirationDate
  • string

证书过期日期。

secretSource

对 Azure 密钥保管库 证书的资源引用。 应采用 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName} 的格式

secretVersion
  • string

要使用的机密版本

subject
  • string

证书中的使用者名称。

subjectAlternativeNames
  • string[]

SAN 列表。

thumbprint
  • string

证书指纹。

type string:
  • CustomerCertificate

机密资源的类型。

useLatestVersion
  • boolean

是否对证书使用最新版本

DeploymentStatus

Name Type Description
Failed
  • string
InProgress
  • string
NotStarted
  • string
Succeeded
  • string

ErrorAdditionalInfo

资源管理错误附加信息。

Name Type Description
info
  • object

其他信息。

type
  • string

其他信息类型。

ErrorDetail

错误详细信息。

Name Type Description
additionalInfo

错误附加信息。

code
  • string

错误代码。

details

错误详细信息。

message
  • string

错误消息。

target
  • string

错误目标。

IdentityType

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

Name Type Description
application
  • string
key
  • string
managedIdentity
  • string
user
  • string

ManagedCertificateParameters

用于 https 的托管证书

Name Type Description
expirationDate
  • string

证书过期日期。

subject
  • string

证书中的使用者名称。

type string:
  • ManagedCertificate

机密资源的类型。

ResourceReference

对另一个资源的引用。

Name Type Description
id
  • string

资源 ID。

Secret

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

Name Type Description
id
  • string

资源 ID。

name
  • string

资源名称。

properties.deploymentStatus
properties.parameters SecretParameters:

包含机密参数的对象

properties.profileName
  • string

保存机密的配置文件的名称。

properties.provisioningState

预配状态

systemData

只读系统数据

type
  • string

资源类型。

SecretType

机密资源的类型。

Name Type Description
AzureFirstPartyManagedCertificate
  • string
CustomerCertificate
  • string
ManagedCertificate
  • string
UrlSigningKey
  • string

SystemData

只读系统数据

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC)

createdBy
  • string

创建资源的标识的标识符

createdByType

创建资源的标识的类型

lastModifiedAt
  • string

资源上次修改的时间戳 (UTC)

lastModifiedBy
  • string

上次修改资源的标识的标识符

lastModifiedByType

上次修改资源的标识的类型

UrlSigningKeyParameters

URL 签名密钥参数

Name Type Description
keyId
  • string

定义客户定义的密钥 ID。此 ID 将存在于传入请求中,以指示用于形成哈希的键。

secretSource

对 Azure 密钥保管库机密的资源引用。 应采用 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{secretName} 的格式

secretVersion
  • string

要使用的机密版本

type string:
  • UrlSigningKey

机密资源的类型。