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