Microsoft.ApiManagement 服務/namedValues 2022-04-01-preview
Bicep 資源定義
服務/namedValues 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.ApiManagement/service/namedValues 資源，請將下列 Bicep 新增至您的範本。
resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2022-04-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
displayName: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
secret: bool
tags: [
'string'
]
value: 'string'
}
}
屬性值
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| identityClientId | SystemAssignedIdentity 或 UserAssignedIdentity 的用戶端標識符為 Null，用來存取密鑰保存庫密碼。 | 字串 |
| secretIdentifier | 用於擷取秘密的金鑰保存庫秘密標識碼。 提供版本設定的秘密將防止自動重新整理。 這需要使用 aka.ms/apimmsi 設定 API 管理服務 | 字串 |
Microsoft.ApiManagement/service/namedValues
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 約束： 最大長度 = 模式 = ^[^*#&+:<>?]+$ （必要） |
| 父母 | 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。 如需詳細資訊，請參閱 父資源外部的子資源。 |
類型的資源符號名稱：服務 |
| 性能 | PUT 作業的 NamedValue 實體合約屬性。 | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| displayName | NamedValue 的唯一名稱。 它只能包含字母、數位、句點、虛線和底線字元。 | 字串 約束： 最小長度 = 1 最大長度 = 1 模式 = ^[A-Za-z0-9-._]+$ （必要） |
| keyVault | namedValue的KeyVault位置詳細數據。 | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| 秘密 | 判斷值是否為秘密，且是否應加密。 默認值為 false。 | bool |
| 標籤 | 提供時可用來篩選 NamedValue 清單的選擇性標籤。 | string[] |
| 價值 | NamedValue 的值。 可以包含原則表達式。 它不可以是空的，或只包含空格符。 此屬性不會填入 『GET』 作業！ 使用 '/listSecrets' POST 要求來取得值。 | 字串 約束： 最大長度 = |
快速入門範例
下列快速入門範例會部署此資源類型。
| Bicep 檔案 | 描述 |
|---|---|
| 使用 API 管理來源 Front Door Standard/Premium | 此範本會建立 Front Door Premium 和 API 管理實例，並使用 NSG 和全域 API 管理原則來驗證流量是否通過 Front Door 來源。 |
ARM 樣本資源定義
服務/namedValues 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.ApiManagement/service/namedValues 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.ApiManagement/service/namedValues",
"apiVersion": "2022-04-01-preview",
"name": "string",
"properties": {
"displayName": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"secret": "bool",
"tags": [ "string" ],
"value": "string"
}
}
屬性值
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| identityClientId | SystemAssignedIdentity 或 UserAssignedIdentity 的用戶端標識符為 Null，用來存取密鑰保存庫密碼。 | 字串 |
| secretIdentifier | 用於擷取秘密的金鑰保存庫秘密標識碼。 提供版本設定的秘密將防止自動重新整理。 這需要使用 aka.ms/apimmsi 設定 API 管理服務 | 字串 |
Microsoft.ApiManagement/service/namedValues
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2022-04-01-preview' |
| 名字 | 資源名稱 | 字串 約束： 最大長度 = 模式 = ^[^*#&+:<>?]+$ （必要） |
| 性能 | PUT 作業的 NamedValue 實體合約屬性。 | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
| 類型 | 資源類型 | 'Microsoft.ApiManagement/service/namedValues' |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| displayName | NamedValue 的唯一名稱。 它只能包含字母、數位、句點、虛線和底線字元。 | 字串 約束： 最小長度 = 1 最大長度 = 1 模式 = ^[A-Za-z0-9-._]+$ （必要） |
| keyVault | namedValue的KeyVault位置詳細數據。 | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| 秘密 | 判斷值是否為秘密，且是否應加密。 默認值為 false。 | bool |
| 標籤 | 提供時可用來篩選 NamedValue 清單的選擇性標籤。 | string[] |
| 價值 | NamedValue 的值。 可以包含原則表達式。 它不可以是空的，或只包含空格符。 此屬性不會填入 『GET』 作業！ 使用 '/listSecrets' POST 要求來取得值。 | 字串 約束： 最大長度 = |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
使用 API 管理來源 Front Door Standard/Premium
|
此範本會建立 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@2022-04-01-preview"
name = "string"
body = jsonencode({
properties = {
displayName = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
secret = bool
tags = [
"string"
]
value = "string"
}
})
}
屬性值
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| identityClientId | SystemAssignedIdentity 或 UserAssignedIdentity 的用戶端標識符為 Null，用來存取密鑰保存庫密碼。 | 字串 |
| secretIdentifier | 用於擷取秘密的金鑰保存庫秘密標識碼。 提供版本設定的秘密將防止自動重新整理。 這需要使用 aka.ms/apimmsi 設定 API 管理服務 | 字串 |
Microsoft.ApiManagement/service/namedValues
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 約束： 最大長度 = 模式 = ^[^*#&+:<>?]+$ （必要） |
| parent_id | 此資源為父系之資源的標識碼。 | 類型的資源標識碼：服務 |
| 性能 | PUT 作業的 NamedValue 實體合約屬性。 | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
| 類型 | 資源類型 | “Microsoft.ApiManagement/service/namedValues@2022-04-01-preview” |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| displayName | NamedValue 的唯一名稱。 它只能包含字母、數位、句點、虛線和底線字元。 | 字串 約束： 最小長度 = 1 最大長度 = 1 模式 = ^[A-Za-z0-9-._]+$ （必要） |
| keyVault | namedValue的KeyVault位置詳細數據。 | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| 秘密 | 判斷值是否為秘密，且是否應加密。 默認值為 false。 | bool |
| 標籤 | 提供時可用來篩選 NamedValue 清單的選擇性標籤。 | string[] |
| 價值 | NamedValue 的值。 可以包含原則表達式。 它不可以是空的，或只包含空格符。 此屬性不會填入 『GET』 作業！ 使用 '/listSecrets' POST 要求來取得值。 | 字串 約束： 最大長度 = |