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

Certificates - Get

获取证书资源。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppPlatform/Spring/{serviceName}/certificates/{certificateName}?api-version=2023-12-01

URI 参数

名称 必需 类型 说明
certificateName
path True

string

证书资源的名称。

resourceGroupName
path True

string

包含该资源的资源组名称。 可以从 Azure 资源管理器 API 或门户获取此值。

serviceName
path True

string

服务资源的名称。

正则表达式模式: ^[a-z][a-z0-9-]*[a-z0-9]$

subscriptionId
path True

string

获取唯一标识 Microsoft Azure 订阅的订阅 ID。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True

string

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

CertificateResource

成功。 响应描述证书。

Other Status Codes

CloudError

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

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Certificates_Get

示例请求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycertificate?api-version=2023-12-01

示例响应

{
  "properties": {
    "type": "KeyVaultCertificate",
    "excludePrivateKey": false,
    "thumbprint": "934367bf1c97033f877db0f15cb1b586957d3133",
    "vaultUri": "https://myvault.vault.azure.net",
    "keyVaultCertName": "mycert",
    "certVersion": "08a219d06d874795a96db47e06fbb01e",
    "issuer": "mydomain.com",
    "issuedDate": "2019-02-20T07:40:42Z",
    "expirationDate": "2019-02-21T07:40:42Z",
    "activateDate": "2019-02-22T07:40:42Z",
    "subjectName": "mysubjectname",
    "dnsNames": [
      "mydomain.com",
      "mydomain.net",
      "mydomain.io"
    ],
    "autoSync": "Disabled",
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "sample-user",
    "createdByType": "User",
    "createdAt": "2021-08-11T03:16:03.944Z",
    "lastModifiedBy": "sample-user",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-08-11T03:17:03.944Z"
  },
  "type": "Microsoft.AppPlatform/Spring/certificates",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/certificates/mycertificate",
  "name": "mycertificate"
}

定义

名称 说明
CertificateResource

证书资源有效负载。

CertificateResourceProvisioningState

证书的预配状态

CloudError

来自服务的错误响应。

CloudErrorBody

来自服务的错误响应。

ContentCertificateProperties

从密钥保管库导入的证书的属性。

createdByType

创建资源的标识类型。

KeyVaultCertificateAutoSync

指示是否自动同步密钥保管库中的证书。

KeyVaultCertificateProperties

从密钥保管库导入的证书的属性。

lastModifiedByType

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

SystemData

与资源的创建和上次修改相关的元数据。

CertificateResource

证书资源有效负载。

名称 类型 说明
id

string

资源的完全限定资源 ID。

name

string

资源的名称。

properties CertificateProperties:

证书资源有效负载的属性。

systemData

SystemData

与资源的创建和上次修改相关的元数据。

type

string

资源类型。

CertificateResourceProvisioningState

证书的预配状态

名称 类型 说明
Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

CloudError

来自服务的错误响应。

名称 类型 说明
error

CloudErrorBody

来自服务的错误响应。

CloudErrorBody

来自服务的错误响应。

名称 类型 说明
code

string

错误的标识符。 代码是固定的,旨在以编程方式使用。

details

CloudErrorBody[]

有关错误的其他详细信息的列表。

message

string

描述错误的消息,该消息适用于在用户界面中显示。

target

string

特定错误的目标。 例如,属性的名称出错。

ContentCertificateProperties

从密钥保管库导入的证书的属性。

名称 类型 说明
activateDate

string

证书的激活日期。

content

string

上传的证书的内容。

dnsNames

string[]

证书的域列表。

expirationDate

string

证书的到期日期。

issuedDate

string

证书的颁发日期。

issuer

string

证书的颁发者。

provisioningState

CertificateResourceProvisioningState

证书的预配状态

subjectName

string

证书的使用者名称。

thumbprint

string

证书的指纹。

type string:

ContentCertificate

证书源的类型。

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

KeyVaultCertificateAutoSync

指示是否自动同步密钥保管库中的证书。

名称 类型 说明
Disabled

string

Enabled

string

KeyVaultCertificateProperties

从密钥保管库导入的证书的属性。

名称 类型 默认值 说明
activateDate

string

证书的激活日期。

autoSync

KeyVaultCertificateAutoSync

Disabled

指示是否自动同步密钥保管库中的证书。

certVersion

string

密钥保管库的证书版本。

dnsNames

string[]

证书的域列表。

excludePrivateKey

boolean

False

可选。 如果设置为 true,则不会从密钥保管库导入私钥。

expirationDate

string

证书的到期日期。

issuedDate

string

证书的颁发日期。

issuer

string

证书的颁发者。

keyVaultCertName

string

密钥保管库的证书名称。

provisioningState

CertificateResourceProvisioningState

证书的预配状态

subjectName

string

证书的使用者名称。

thumbprint

string

证书的指纹。

type string:

KeyVaultCertificate

证书源的类型。

vaultUri

string

用户密钥保管库的保管库 URI。

lastModifiedByType

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

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

SystemData

与资源的创建和上次修改相关的元数据。

名称 类型 说明
createdAt

string

资源创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

资源修改的时间戳 (UTC) 。

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

lastModifiedByType

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