你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.ApiManagement 服务/namedValues 2022-08-01
Bicep 资源定义
service/namedValues 资源类型可以通过针对以下操作进行部署：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/namedValues 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2022-08-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
displayName: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
secret: bool
tags: [
'string'
]
value: 'string'
}
}
属性值
service/namedValues
| 名称 | 说明 | 值 |
|---|---|---|
| name | 资源名称 了解如何在 Bicep 中为子资源设置名称和类型。 |
字符串 (必需) |
| 父级 (parent) | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源之外的子资源。 |
类型为“服务”的资源的符号名称 |
| properties | PUT 操作的 NamedValue 实体协定属性。 | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| 名称 | 说明 | 值 |
|---|---|---|
| displayName | NamedValue 的唯一名称。 可能包含字母、数字、句点、短划线和下划线字符。 | 字符串 (必需) |
| keyVault | namedValue 的 KeyVault 位置详细信息。 | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| secret | 确定值是否为密钥以及是否应加密。 默认值为 false。 | bool |
| 标记 | 提供的可选标记可用于筛选 NamedValue 列表。 | string[] |
| value | NamedValue 的值。 可以包含策略表达式。 不能为空或只由空格组成。 此属性不会在“GET”操作上填充！ 使用“/listSecrets”POST 请求获取值。 | 字符串 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| 名称 | 说明 | 值 |
|---|---|---|
| identityClientId | SystemAssignedIdentity 为 Null，或 UserAssignedIdentity 的客户端 ID，用于访问密钥保管库机密。 | 字符串 |
| secretIdentifier | 用于提取机密的密钥保管库机密标识符。 提供版本控制机密将阻止自动刷新。 这要求API 管理服务配置 aka.ms/apimmsi | 字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 说明 |
|---|---|
具有API 管理源的 Front Door 标准版/高级版 |
此模板创建 Front Door Premium 和 API 管理 实例，并使用 NSG 和全局API 管理策略来验证流量是否已通过 Front Door 源。 |
ARM 模板资源定义
service/namedValues 资源类型可以通过针对以下操作进行部署：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/namedValues 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.ApiManagement/service/namedValues",
"apiVersion": "2022-08-01",
"name": "string",
"properties": {
"displayName": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"secret": "bool",
"tags": [ "string" ],
"value": "string"
}
}
属性值
service/namedValues
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | 'Microsoft.ApiManagement/service/namedValues' |
| apiVersion | 资源 API 版本 | '2022-08-01' |
| name | 资源名称 了解如何在 JSON ARM 模板中为子资源设置名称和类型。 |
字符串 (必需) |
| properties | PUT 操作的 NamedValue 实体协定属性。 | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| 名称 | 说明 | 值 |
|---|---|---|
| displayName | NamedValue 的唯一名称。 可能包含字母、数字、句点、短划线和下划线字符。 | 字符串 (必需) |
| keyVault | namedValue 的 KeyVault 位置详细信息。 | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| secret | 确定值是否为密钥以及是否应加密。 默认值为 false。 | bool |
| 标记 | 提供的可选标记可用于筛选 NamedValue 列表。 | string[] |
| value | NamedValue 的值。 可以包含策略表达式。 不能为空或只由空格组成。 此属性不会在“GET”操作上填充！ 使用“/listSecrets”POST 请求获取值。 | 字符串 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| 名称 | 说明 | 值 |
|---|---|---|
| identityClientId | 对于 SystemAssignedIdentity，或 UserAssignedIdentity 的客户端 ID 为 Null，这将用于访问密钥保管库机密。 | 字符串 |
| secretIdentifier | 用于提取机密的密钥保管库机密标识符。 提供版本控制机密将阻止自动刷新。 这要求API 管理服务配置 aka.ms/apimmsi | 字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 说明 |
|---|---|
| 具有API 管理源的 Front Door 标准版/高级版 |
此模板创建 Front Door Premium 和 API 管理 实例，并使用 NSG 和全局API 管理策略来验证流量是否已通过 Front Door 源。 |
Terraform (AzAPI 提供程序) 资源定义
可以使用面向以下操作部署 service/namedValues 资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/namedValues 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/namedValues@2022-08-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
displayName = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
secret = bool
tags = [
"string"
]
value = "string"
}
})
}
属性值
service/namedValues
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.ApiManagement/service/namedValues@2022-08-01” |
| name | 资源名称 | 字符串 (必需) |
| parent_id | 此资源的父资源的 ID。 | 类型为：service 的资源的 ID |
| properties | PUT 操作的 NamedValue 实体协定属性。 | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| 名称 | 说明 | 值 |
|---|---|---|
| displayName | NamedValue 的唯一名称。 可能包含字母、数字、句点、短划线和下划线字符。 | 字符串 (必需) |
| keyVault | namedValue 的 KeyVault 位置详细信息。 | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| secret | 确定值是否为密钥以及是否应加密。 默认值为 false。 | bool |
| 标记 | 提供的可选标记可用于筛选 NamedValue 列表。 | string[] |
| value | NamedValue 的值。 可以包含策略表达式。 不能为空或只由空格组成。 此属性不会在“GET”操作上填充！ 使用“/listSecrets”POST 请求获取值。 | 字符串 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| 名称 | 说明 | 值 |
|---|---|---|
| identityClientId | 对于 SystemAssignedIdentity，或 UserAssignedIdentity 的客户端 ID 为 Null，这将用于访问密钥保管库机密。 | 字符串 |
| secretIdentifier | 用于提取机密的密钥保管库机密标识符。 提供版本控制机密将阻止自动刷新。 这要求API 管理服务配置 aka.ms/apimmsi | 字符串 |