你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.ApiManagement service/certificates 2023-03-01-preview
Bicep 资源定义
可以使用面向以下操作部署服务/证书资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/certificates 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.ApiManagement/service/certificates@2023-03-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
data: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
password: 'string'
}
}
属性值
service/certificates
| 名称 | 说明 | 值 |
|---|---|---|
| name | 资源名称 了解如何在 Bicep 中设置子资源的名称和类型。 |
字符串 (必需) 字符限制：1-80 有效字符： 字母数字和连字符。 以字母开头且以字母数字结尾。 |
| 父级 (parent) | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源之外的子资源。 |
类型为：service 的资源的符号名称 |
| properties | 证书创建或更新属性详细信息。 | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| 名称 | 说明 | 值 |
|---|---|---|
| data | 使用 application/x-pkcs12 表示形式的 Base 64 编码证书。 | 字符串 |
| keyVault | 证书的 KeyVault 位置详细信息。 | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| password | 证书的密码 | 字符串 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| 名称 | 说明 | 值 |
|---|---|---|
| identityClientId | 对于 SystemAssignedIdentity，或 UserAssignedIdentity 的客户端 ID 为 Null，这将用于访问密钥保管库机密。 | 字符串 |
| secretIdentifier | 用于提取机密的密钥保管库机密标识符。 提供版本控制机密将阻止自动刷新。 这要求API 管理服务配置 aka.ms/apimmsi | 字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 说明 |
|---|---|
使用模板创建 API 管理实例和所有子资源 |
此模板演示如何创建API 管理服务和配置子实体 |
ARM 模板资源定义
可以使用面向以下操作部署服务/证书资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/certificates 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.ApiManagement/service/certificates",
"apiVersion": "2023-03-01-preview",
"name": "string",
"properties": {
"data": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"password": "string"
}
}
属性值
service/certificates
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.ApiManagement/service/certificates” |
| apiVersion | 资源 API 版本 | “2023-03-01-preview” |
| name | 资源名称 了解如何在 JSON ARM 模板中设置子资源的名称和类型。 |
字符串 (必需) 字符限制：1-80 有效字符： 字母数字和连字符。 以字母开头且以字母数字结尾。 |
| properties | 证书创建或更新属性详细信息。 | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| 名称 | 说明 | 值 |
|---|---|---|
| data | 使用 application/x-pkcs12 表示形式的 Base 64 编码证书。 | 字符串 |
| keyVault | 证书的 KeyVault 位置详细信息。 | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| password | 证书的密码 | 字符串 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| 名称 | 说明 | 值 |
|---|---|---|
| identityClientId | 对于 SystemAssignedIdentity，或 UserAssignedIdentity 的客户端 ID 为 Null，这将用于访问密钥保管库机密。 | 字符串 |
| secretIdentifier | 用于提取机密的密钥保管库机密标识符。 提供版本控制机密将阻止自动刷新。 这要求API 管理服务配置 aka.ms/apimmsi | 字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 说明 |
|---|---|
| 使用模板创建 API 管理实例和所有子资源 |
此模板演示如何创建API 管理服务和配置子实体 |
Terraform (AzAPI 提供程序) 资源定义
可以使用面向以下操作部署服务/证书资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/certificates 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/certificates@2023-03-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
data = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
password = "string"
}
})
}
属性值
service/certificates
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.ApiManagement/service/certificates@2023-03-01-preview” |
| name | 资源名称 | 字符串 (必需) 字符限制：1-80 有效字符： 字母数字和连字符。 以字母开头且以字母数字结尾。 |
| parent_id | 此资源的父资源的 ID。 | 类型为：service 的资源的 ID |
| properties | 证书创建或更新属性详细信息。 | CertificateCreateOrUpdatePropertiesOrCertificateCont... |
CertificateCreateOrUpdatePropertiesOrCertificateCont...
| 名称 | 说明 | 值 |
|---|---|---|
| data | 使用 application/x-pkcs12 表示形式的 Base 64 编码证书。 | 字符串 |
| keyVault | 证书的 KeyVault 位置详细信息。 | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| password | 证书的密码 | 字符串 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| 名称 | 说明 | 值 |
|---|---|---|
| identityClientId | 对于 SystemAssignedIdentity，或 UserAssignedIdentity 的客户端 ID 为 Null，这将用于访问密钥保管库机密。 | 字符串 |
| secretIdentifier | 用于提取机密的密钥保管库机密标识符。 提供版本控制机密将阻止自动刷新。 这要求API 管理服务配置 aka.ms/apimmsi | 字符串 |