Aracılığıyla paylaş

Microsoft.ApiManagement hizmeti/namedValues

  • Makale

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@2024-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    displayName: 'string'
    keyVault: {
      identityClientId: 'string'
      secretIdentifier: 'string'
    }
    secret: bool
    tags: [
      'string'
    ]
    value: 'string'
  }
}

Özellik Değerleri

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

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

Microsoft.ApiManagement/service/namedValues

Ad Açıklama Değer
ad Kaynak adı dizgi

Kısıtlama -ları:
Maksimum uzunluk = 256
Desen = ^[^*#&+:<>?]+$ (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. NamedValueCreateContractPropertiesOrNamedValueContractProperties

NamedValueCreateContractPropertiesOrNamedValueContractProperties

Ad Açıklama Değer
ekran adı NamedValue'nun benzersiz adı. Yalnızca harf, rakam, nokta, tire ve alt çizgi karakterleri içerebilir. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 256
Desen = ^[A-Za-z0-9-._]+$ (gerekli)
keyVault NamedValue değerinin KeyVault konum ayrıntıları. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
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[]
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

Kullanım Örnekleri

Azure Hızlı Başlangıç Örnekleri

Aşağıdaki Azure Hızlı Başlangıç şablonları bu kaynak türünü dağıtmak için Bicep örnekleri içerir.

Bicep Dosyası Açıklama
API Management kaynağı ile Front Door Standard/Premium 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": "2024-06-01-preview",
  "name": "string",
  "properties": {
    "displayName": "string",
    "keyVault": {
      "identityClientId": "string",
      "secretIdentifier": "string"
    },
    "secret": "bool",
    "tags": [ "string" ],
    "value": "string"
  }
}

Özellik Değerleri

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

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

Microsoft.ApiManagement/service/namedValues

Ad Açıklama Değer
apiVersiyonu API sürümü '2024-06-01-preview'
ad Kaynak adı dizgi

Kısıtlama -ları:
Maksimum uzunluk = 256
Desen = ^[^*#&+:<>?]+$ (gerekli)
Özellikler PUT işlemi için NamedValue varlık sözleşmesi özellikleri. NamedValueCreateContractPropertiesOrNamedValueContractProperties
tür Kaynak türü 'Microsoft.ApiManagement/service/namedValues'

NamedValueCreateContractPropertiesOrNamedValueContractProperties

Ad Açıklama Değer
ekran adı NamedValue'nun benzersiz adı. Yalnızca harf, rakam, nokta, tire ve alt çizgi karakterleri içerebilir. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 256
Desen = ^[A-Za-z0-9-._]+$ (gerekli)
keyVault NamedValue değerinin KeyVault konum ayrıntıları. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
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[]
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

Kullanım Örnekleri

Azure Hızlı Başlangıç Şablonları

Aşağıdaki Azure Hızlı Başlangıç şablonları bu kaynak türünü dağıtmak.

Şablon Açıklama
API Management kaynağı ile Front Door Standard/Premium

Azure'a dağıtım		 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@2024-06-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      displayName = "string"
      keyVault = {
        identityClientId = "string"
        secretIdentifier = "string"
      }
      secret = bool
      tags = [
        "string"
      ]
      value = "string"
    }
  }
}

Özellik Değerleri

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

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

Microsoft.ApiManagement/service/namedValues

Ad Açıklama Değer
ad Kaynak adı dizgi

Kısıtlama -ları:
Maksimum uzunluk = 256
Desen = ^[^*#&+:<>?]+$ (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. NamedValueCreateContractPropertiesOrNamedValueContractProperties
tür Kaynak türü "Microsoft.ApiManagement/service/namedValues@2024-06-01-preview"

NamedValueCreateContractPropertiesOrNamedValueContractProperties

Ad Açıklama Değer
ekran adı NamedValue'nun benzersiz adı. Yalnızca harf, rakam, nokta, tire ve alt çizgi karakterleri içerebilir. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 256
Desen = ^[A-Za-z0-9-._]+$ (gerekli)
keyVault NamedValue değerinin KeyVault konum ayrıntıları. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
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[]
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