Bicep 資源定義
服務/namedValues 資源類型可以使用目標作業來部署:
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
使用範例
Bicep 範例
部署 API 管理 具名值的基本範例。
param resourceName string = 'acctest0001'
param location string = 'westeurope'
resource service 'Microsoft.ApiManagement/service@2021-08-01' = {
name: resourceName
location: location
sku: {
capacity: 0
name: 'Consumption'
}
properties: {
certificates: []
customProperties: {
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11': 'false'
}
disableGateway: false
publicNetworkAccess: 'Enabled'
publisherEmail: 'pub1@email.com'
publisherName: 'pub1'
virtualNetworkType: 'None'
}
}
resource namedValue 'Microsoft.ApiManagement/service/namedValues@2021-08-01' = {
name: resourceName
parent: service
properties: {
displayName: 'TestProperty230630032559683679'
secret: false
tags: [
'tag1'
'tag2'
]
value: 'Test Value'
}
}
Azure 已驗證的模組
下列 Azure 驗證模組 可用來部署此資源類型。
| Module | 描述 |
|---|---|
| API 管理服務 - 命名值 | API 管理服務的 AVM 子模組 - 命名值 |
Azure 快速入門範例
下列 Azure 快速入門範本 包含用於部署此資源類型的 Bicep 範例。
| Bicep 檔案 | 描述 |
|---|---|
| 使用 API 管理來源 Front Door Standard/Premium | 此範本會建立 Front Door Premium 和 API 管理實例,並使用 NSG 和全域 API 管理原則來驗證流量是否通過 Front Door 來源。 |
資源格式
若要建立 Microsoft.ApiManagement/service/namedValues 資源,請將下列 Bicep 新增至您的範本。
resource symbolicname 'Microsoft.ApiManagement/service/namedValues@2021-12-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
displayName: 'string'
keyVault: {
identityClientId: 'string'
secretIdentifier: 'string'
}
secret: bool
tags: [
'string'
]
value: 'string'
}
}
屬性值
Microsoft.ApiManagement/service/namedValues
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 約束: 最大長度 = 256 模式 = ^[^*#&+:<>?]+$ (必要) |
| 父代 | 在 Bicep 中,您可以指定子資源的父資源。 只有在父資源外部宣告子資源時,才需要新增這個屬性。 如需詳細資訊,請參閱 父資源外部的子資源。 |
類型的資源符號名稱:服務 |
| 性能 | PUT 作業的 NamedValue 實體合約屬性。 | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| identityClientId | SystemAssignedIdentity 或 UserAssignedIdentity 的用戶端標識符為 Null,用來存取密鑰保存庫密碼。 | 字串 |
| secretIdentifier 的 | 用於擷取秘密的金鑰保存庫秘密標識碼。 提供版本設定的秘密將防止自動重新整理。 這需要使用 aka.ms/apimmsi 設定 API 管理服務 | 字串 |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 顯示名稱 | NamedValue 的唯一名稱。 它只能包含字母、數位、句點、虛線和底線字元。 | 字串 約束: 最小長度 = 1 最大長度 = 256 模式 = ^[A-Za-z0-9-._]+$ (必要) |
| keyVault | namedValue的KeyVault位置詳細數據。 | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| 密碼 | 判斷值是否為秘密,且是否應加密。 默認值為 false。 | 布爾 (bool) |
| 標籤 | 提供時可用來篩選 NamedValue 清單的選擇性標籤。 | 字串[] |
| 價值 | NamedValue 的值。 可以包含原則表達式。 它不可以是空的,或只包含空格符。 此屬性不會填入 『GET』 作業! 使用 '/listSecrets' POST 要求來取得值。 | 字串 約束: 最大長度 = 4096 |
ARM 樣本資源定義
服務/namedValues 資源類型可以使用目標作業來部署:
使用範例
Azure 快速入門範本
下列 Azure 快速入門範本 部署此資源類型。
| 範本 | 描述 |
|---|---|
| 使用 API 管理來源 Front Door Standard/Premium |
此範本會建立 Front Door Premium 和 API 管理實例,並使用 NSG 和全域 API 管理原則來驗證流量是否通過 Front Door 來源。 |
資源格式
若要建立 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"
}
}
屬性值
Microsoft.ApiManagement/service/namedValues
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | “2021-12-01-預覽” |
| 名字 | 資源名稱 | 字串 約束: 最大長度 = 256 模式 = ^[^*#&+:<>?]+$ (必要) |
| 性能 | PUT 作業的 NamedValue 實體合約屬性。 | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
| 型別 | 資源類型 | “Microsoft.ApiManagement/service/namedValues” |
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| identityClientId | SystemAssignedIdentity 或 UserAssignedIdentity 的用戶端標識符為 Null,用來存取密鑰保存庫密碼。 | 字串 |
| secretIdentifier 的 | 用於擷取秘密的金鑰保存庫秘密標識碼。 提供版本設定的秘密將防止自動重新整理。 這需要使用 aka.ms/apimmsi 設定 API 管理服務 | 字串 |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 顯示名稱 | NamedValue 的唯一名稱。 它只能包含字母、數位、句點、虛線和底線字元。 | 字串 約束: 最小長度 = 1 最大長度 = 256 模式 = ^[A-Za-z0-9-._]+$ (必要) |
| keyVault | namedValue的KeyVault位置詳細數據。 | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| 密碼 | 判斷值是否為秘密,且是否應加密。 默認值為 false。 | 布爾 (bool) |
| 標籤 | 提供時可用來篩選 NamedValue 清單的選擇性標籤。 | 字串[] |
| 價值 | NamedValue 的值。 可以包含原則表達式。 它不可以是空的,或只包含空格符。 此屬性不會填入 『GET』 作業! 使用 '/listSecrets' POST 要求來取得值。 | 字串 約束: 最大長度 = 4096 |
Terraform (AzAPI 提供者) 資源定義
服務/namedValues 資源類型可以使用目標作業來部署:
- 資源團體 關於每個 API 版本變更屬性的清單,請參見 變更日誌。
使用範例
Terraform 範例
部署 API 管理 具名值的基本範例。
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "service" {
type = "Microsoft.ApiManagement/service@2021-08-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
certificates = [
]
customProperties = {
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11" = "false"
}
disableGateway = false
publicNetworkAccess = "Enabled"
publisherEmail = "pub1@email.com"
publisherName = "pub1"
virtualNetworkType = "None"
}
sku = {
capacity = 0
name = "Consumption"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "namedValue" {
type = "Microsoft.ApiManagement/service/namedValues@2021-08-01"
parent_id = azapi_resource.service.id
name = var.resource_name
body = {
properties = {
displayName = "TestProperty230630032559683679"
secret = false
tags = [
"tag1",
"tag2",
]
value = "Test Value"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
資源格式
若要建立 Microsoft.ApiManagement/service/namedValues 資源,請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/namedValues@2021-12-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
displayName = "string"
keyVault = {
identityClientId = "string"
secretIdentifier = "string"
}
secret = bool
tags = [
"string"
]
value = "string"
}
}
}
屬性值
Microsoft.ApiManagement/service/namedValues
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 約束: 最大長度 = 256 模式 = ^[^*#&+:<>?]+$ (必要) |
| 父項識別碼 | 此資源為父系之資源的標識碼。 | 類型的資源標識碼:服務 |
| 性能 | PUT 作業的 NamedValue 實體合約屬性。 | NamedValueCreateContractPropertiesOrNamedValueContractProperties |
| 型別 | 資源類型 | “Microsoft.ApiManagement/service/namedValues@2021-12-01-preview” |
KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| identityClientId | SystemAssignedIdentity 或 UserAssignedIdentity 的用戶端標識符為 Null,用來存取密鑰保存庫密碼。 | 字串 |
| secretIdentifier 的 | 用於擷取秘密的金鑰保存庫秘密標識碼。 提供版本設定的秘密將防止自動重新整理。 這需要使用 aka.ms/apimmsi 設定 API 管理服務 | 字串 |
NamedValueCreateContractPropertiesOrNamedValueContractProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 顯示名稱 | NamedValue 的唯一名稱。 它只能包含字母、數位、句點、虛線和底線字元。 | 字串 約束: 最小長度 = 1 最大長度 = 256 模式 = ^[A-Za-z0-9-._]+$ (必要) |
| keyVault | namedValue的KeyVault位置詳細數據。 | KeyVaultContractCreatePropertiesOrKeyVaultContractProperties |
| 密碼 | 判斷值是否為秘密,且是否應加密。 默認值為 false。 | 布爾 (bool) |
| 標籤 | 提供時可用來篩選 NamedValue 清單的選擇性標籤。 | 字串[] |
| 價值 | NamedValue 的值。 可以包含原則表達式。 它不可以是空的,或只包含空格符。 此屬性不會填入 『GET』 作業! 使用 '/listSecrets' POST 要求來取得值。 | 字串 約束: 最大長度 = 4096 |