Microsoft.ApiManagement hizmeti/namedValues 2022-08-01
Bicep kaynak tanımı
Service/namedValues kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:
- kaynak grupları
- Bkz. kaynak grubu dağıtım komutları
Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.
Kaynak biçimi
Microsoft.ApiManagement/service/namedValues kaynağı oluşturmak için, şablonunuza aşağıdaki Bicep'i ekleyin.
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'
}
}
Özellik değerleri
service/namedValues
| Ad | Açıklama | Değer |
|---|---|---|
| ad | Kaynak adı Bicep'nde alt kaynaklar için adları ve türleri ayarlamayı öğrenin. |
dize (gerekli) |
| ebeveyn | Bicep'te bir alt kaynak için üst kaynak belirtebilirsiniz. Bu özelliği yalnızca alt kaynak üst kaynağın dışında bildirildiğinde eklemeniz gerekir. Daha fazla bilgi için bkz. Alt kaynaküst kaynak dışında. |
Kaynak türü için sembolik ad: hizmet |
| Özellikler | PUT işlemi için NamedValue varlık sözleşmesi özellikleri. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Ad | Açıklama | Değer |
|---|---|---|
| displayName | NamedValue'nun benzersiz adı. Yalnızca harf, rakam, nokta, tire ve alt çizgi karakterleri içerebilir. | dize (gerekli) Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 256 Desen = ^[A-Za-z0-9-._]+$ |
| keyVault | NamedValue değerinin KeyVault konum ayrıntıları. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| gizli | Değerin gizli dizi olup olmadığını ve şifrelenip şifrelenmemesi gerektiğini belirler. Varsayılan değer false'tur. | Bool |
| Etiketler | Sağlandığında NamedValue listesini filtrelemek için kullanılabilen isteğe bağlı etiketler. | string[] Kısıtlama -ları: Maksimum uzunluk = 32 |
| değer | NamedValue değeri. İlke ifadeleri içerebilir. Boş olmayabilir veya yalnızca boşluklardan oluşabilir. Bu özellik 'GET' işlemlerinde doldurulmayacak! Değeri almak için '/listSecrets' POST isteğini kullanın. | dizgi Kısıtlama -ları: Maksimum uzunluk = 4096 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Ad | Açıklama | Değer |
|---|---|---|
| identityClientId | Anahtar kasası gizli dizisine erişmek için kullanılacak Olan SystemAssignedIdentity için Null veya UserAssignedIdentity İstemci Kimliği. | dizgi |
| secretIdentifier | Gizli diziyi getirmek için anahtar kasası gizli dizi tanımlayıcısı. Sürümlü gizli dizi sağlamak otomatik yenilemeyi engeller. Bunun için API Management hizmetinin aka.ms/apimmsi ile yapılandırılması gerekir | dizgi |
Hızlı başlangıç şablonları
Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.
| Şablon | Açıklama |
|---|---|
API Management kaynağı ile Front Door Standard/Premium 
'a dağıtma |
Bu şablon bir Front Door Premium ve API Management örneği oluşturur ve trafiğin Front Door kaynağından geldiğini doğrulamak için bir NSG ve genel API Management ilkesi kullanır. |
ARM şablonu kaynak tanımı
Service/namedValues kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:
- kaynak grupları
- Bkz. kaynak grubu dağıtım komutları
Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.
Kaynak biçimi
Microsoft.ApiManagement/service/namedValues kaynağı oluşturmak için, şablonunuza aşağıdaki JSON'u ekleyin.
{
"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"
}
}
Özellik değerleri
service/namedValues
| Ad | Açıklama | Değer |
|---|---|---|
| tür | Kaynak türü | 'Microsoft.ApiManagement/service/namedValues' |
| apiVersion | Kaynak API'sinin sürümü | '2022-08-01' |
| ad | Kaynak adı |
dize (gerekli) |
| Özellikler | PUT işlemi için NamedValue varlık sözleşmesi özellikleri. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Ad | Açıklama | Değer |
|---|---|---|
| displayName | NamedValue'nun benzersiz adı. Yalnızca harf, rakam, nokta, tire ve alt çizgi karakterleri içerebilir. | dize (gerekli) Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 256 Desen = ^[A-Za-z0-9-._]+$ |
| keyVault | NamedValue değerinin KeyVault konum ayrıntıları. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| gizli | Değerin gizli dizi olup olmadığını ve şifrelenip şifrelenmemesi gerektiğini belirler. Varsayılan değer false'tur. | Bool |
| Etiketler | Sağlandığında NamedValue listesini filtrelemek için kullanılabilen isteğe bağlı etiketler. | string[] Kısıtlama -ları: Maksimum uzunluk = 32 |
| değer | NamedValue değeri. İlke ifadeleri içerebilir. Boş olmayabilir veya yalnızca boşluklardan oluşabilir. Bu özellik 'GET' işlemlerinde doldurulmayacak! Değeri almak için '/listSecrets' POST isteğini kullanın. | dizgi Kısıtlama -ları: Maksimum uzunluk = 4096 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Ad | Açıklama | Değer |
|---|---|---|
| identityClientId | Anahtar kasası gizli dizisine erişmek için kullanılacak Olan SystemAssignedIdentity için Null veya UserAssignedIdentity İstemci Kimliği. | dizgi |
| secretIdentifier | Gizli diziyi getirmek için anahtar kasası gizli dizi tanımlayıcısı. Sürümlü gizli dizi sağlamak otomatik yenilemeyi engeller. Bunun için API Management hizmetinin aka.ms/apimmsi ile yapılandırılması gerekir | dizgi |
Hızlı başlangıç şablonları
Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.
| Şablon | Açıklama |
|---|---|
| API Management kaynağı ile Front Door Standard/Premium
'a dağıtma |
Bu şablon bir Front Door Premium ve API Management örneği oluşturur ve trafiğin Front Door kaynağından geldiğini doğrulamak için bir NSG ve genel API Management ilkesi kullanır. |
Terraform (AzAPI sağlayıcısı) kaynak tanımı
Service/namedValues kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:
- Kaynak grupları
Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.
Kaynak biçimi
Microsoft.ApiManagement/service/namedValues kaynağı oluşturmak için şablonunuza aşağıdaki Terraform'u ekleyin.
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"
}
})
}
Özellik değerleri
service/namedValues
| Ad | Açıklama | Değer |
|---|---|---|
| tür | Kaynak türü | "Microsoft.ApiManagement/service/namedValues@2022-08-01" |
| ad | Kaynak adı | dize (gerekli) |
| parent_id | Bu kaynağın üst öğesi olan kaynağın kimliği. | Kaynak türü için kimlik: hizmet |
| Özellikler | PUT işlemi için NamedValue varlık sözleşmesi özellikleri. | NamedValueCreateContractPropertiesOrNamedValueContra... |
NamedValueCreateContractPropertiesOrNamedValueContra...
| Ad | Açıklama | Değer |
|---|---|---|
| displayName | NamedValue'nun benzersiz adı. Yalnızca harf, rakam, nokta, tire ve alt çizgi karakterleri içerebilir. | dize (gerekli) Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 256 Desen = ^[A-Za-z0-9-._]+$ |
| keyVault | NamedValue değerinin KeyVault konum ayrıntıları. | KeyVaultContractCreatePropertiesOrKeyVaultContractPr... |
| gizli | Değerin gizli dizi olup olmadığını ve şifrelenip şifrelenmemesi gerektiğini belirler. Varsayılan değer false'tur. | Bool |
| Etiketler | Sağlandığında NamedValue listesini filtrelemek için kullanılabilen isteğe bağlı etiketler. | string[] Kısıtlama -ları: Maksimum uzunluk = 32 |
| değer | NamedValue değeri. İlke ifadeleri içerebilir. Boş olmayabilir veya yalnızca boşluklardan oluşabilir. Bu özellik 'GET' işlemlerinde doldurulmayacak! Değeri almak için '/listSecrets' POST isteğini kullanın. | dizgi Kısıtlama -ları: Maksimum uzunluk = 4096 |
KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
| Ad | Açıklama | Değer |
|---|---|---|
| identityClientId | Anahtar kasası gizli dizisine erişmek için kullanılacak Olan SystemAssignedIdentity için Null veya UserAssignedIdentity İstemci Kimliği. | dizgi |
| secretIdentifier | Gizli diziyi getirmek için anahtar kasası gizli dizi tanımlayıcısı. Sürümlü gizli dizi sağlamak otomatik yenilemeyi engeller. Bunun için API Management hizmetinin aka.ms/apimmsi ile yapılandırılması gerekir | dizgi |