Microsoft.ApiManagement service/namedValues 2021-12-01-preview
Bicep 資源定義
服務/namedValues 資源類型可以部署至：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
資源格式
若要建立 Microsoft.ApiManagement/service/namedValues 資源，請將下列 Bicep 新增至您的範本。
resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2021-12-01-preview' = {
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 |
| tags | 選擇性標記，當提供時可用來篩選 NamedValue 清單。 | string[] |
| value | NamedValue 的值。 可以包含原則運算式。 不能是空白或只由空白字元組成。 此屬性不會填入 'GET' 作業！ 使用 '/listSecrets' POST 要求來取得值。 | 字串 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| 名稱 | 描述 | 值 |
|---|---|---|
| identityClientId | SystemAssignedIdentity 的 Null 或 UserAssignedIdentity 的用戶端識別碼，其將用來存取金鑰保存庫密碼。 | 字串 |
| secretIdentifier | 用於擷取秘密的金鑰保存庫秘密識別碼。 提供已設定版本的秘密會防止自動重新整理。 這需要API 管理服務設定 aka.ms/apimmsi | 字串 |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
具有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": "2021-12-01-preview",
"name": "string",
"properties": {
"displayName": "string",
"keyVault": {
"identityClientId": "string",
"secretIdentifier": "string"
},
"secret": "bool",
"tags": [ "string" ],
"value": "string"
}
}
屬性值
service/namedValues
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | 'Microsoft.ApiManagement/service/namedValues' |
| apiVersion | 資源 API 版本 | '2021-12-01-preview' |
| NAME | 資源名稱 請參閱如何在 JSON ARM 範本中設定子資源的名稱和類型。 |
字串 (必要) |
| properties | PUT 作業的 NamedValue 實體合約屬性。 | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| 名稱 | 描述 | 值 |
|---|---|---|
| displayName | NamedValue 的唯一名稱。 只能包含字母、數字、句點、破折號和底線字元。 | 字串 (必要) |
| keyVault | namedValue 的 KeyVault 位置詳細資料。 | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| secret | 決定該值是否為密碼且是否應該加密。 預設值為 false。 | bool |
| tags | 選擇性標記，當提供時可用來篩選 NamedValue 清單。 | string[] |
| value | NamedValue 的值。 可以包含原則運算式。 不能是空白或只由空白字元組成。 此屬性不會填入 'GET' 作業！ 使用 '/listSecrets' POST 要求來取得值。 | 字串 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| 名稱 | 描述 | 值 |
|---|---|---|
| identityClientId | SystemAssignedIdentity 的 Null 或 UserAssignedIdentity 的用戶端識別碼，其將用來存取金鑰保存庫密碼。 | 字串 |
| secretIdentifier | 用於擷取秘密的金鑰保存庫秘密識別碼。 提供已設定版本的秘密會防止自動重新整理。 這需要API 管理服務設定 aka.ms/apimmsi | 字串 |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
| 具有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@2021-12-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
displayName = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
secret = bool
tags = [
"string"
]
value = "string"
}
})
}
屬性值
service/namedValues
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | 「Microsoft.ApiManagement/service/namedValues@2021-12-01-preview」 |
| NAME | 資源名稱 | 字串 (必要) |
| parent_id | 此資源之父系的資源識別碼。 | 類型資源的識別碼： 服務 |
| properties | PUT 作業的 NamedValue 實體合約屬性。 | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| 名稱 | 描述 | 值 |
|---|---|---|
| displayName | NamedValue 的唯一名稱。 只能包含字母、數字、句點、破折號和底線字元。 | 字串 (必要) |
| keyVault | namedValue 的 KeyVault 位置詳細資料。 | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| secret | 決定該值是否為密碼且是否應該加密。 預設值為 false。 | bool |
| tags | 選擇性標記，當提供時可用來篩選 NamedValue 清單。 | string[] |
| value | NamedValue 的值。 可以包含原則運算式。 不能是空白或只由空白字元組成。 此屬性不會填入 'GET' 作業！ 使用 '/listSecrets' POST 要求來取得值。 | 字串 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| 名稱 | 描述 | 值 |
|---|---|---|
| identityClientId | SystemAssignedIdentity 的 Null 或 UserAssignedIdentity 的用戶端識別碼，其將用來存取金鑰保存庫密碼。 | 字串 |
| secretIdentifier | 用於擷取秘密的金鑰保存庫秘密識別碼。 提供已建立版本的秘密將會防止自動重新整理。 這需要以 aka.ms/apimmsi 設定API 管理服務 | 字串 |