Aracılığıyla paylaş


Microsoft.ApiManagement hizmeti/namedValues 2023-05-01-preview

Bicep kaynak tanımı

Service/namedValues kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

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@2023-05-01-preview' = {
  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
name Kaynak adı

Bicep'te alt kaynaklar için adları ve türleri ayarlamayı öğrenin.
dize (gerekli)
Üst Bicep'te bir alt kaynağın üst kaynağını belirtebilirsiniz. Bu özelliği yalnızca alt kaynak üst kaynağın dışında bildirildiğinde eklemeniz gerekir.

Daha fazla bilgi için bkz . Üst kaynağın dışındaki alt kaynak.
Şu tür kaynak için sembolik ad: hizmet
properties 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)
keyVault namedValue değerinin KeyVault konum ayrıntıları. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
gizli dizi 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şamayabilir. Bu özellik 'GET' işlemlerinde doldurulmayacak! Değeri almak için '/listSecrets' POST isteğini kullanın. string

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. string
secretIdentifier Gizli diziyi getirmek için anahtar kasası gizli dizi tanımlayıcısı. Sürümlü bir gizli dizi sağlamak otomatik yenilemeyi engeller. Bunun için API Management hizmetinin aka.ms/apimmsi ile yapılandırılması gerekir string

Hızlı başlangıç şablonları

Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.

Şablon Description
API Management çıkış noktası ile Front Door Standard/Premium

Azure’a dağıtın
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:

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": "2023-05-01-preview",
  "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ü '2023-05-01-preview'
name Kaynak adı

Bkz. JSON ARM şablonlarında alt kaynaklar için adları ve türleri ayarlama.
dize (gerekli)
properties 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)
keyVault AdlıDeğer'in KeyVault konum ayrıntıları. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
gizli dizi 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. dize[]
değer NamedValue değeri. İlke ifadeleri içerebilir. Boş olmayabilir veya yalnızca boşluklardan oluşamayabilir. Bu özellik 'GET' işlemlerinde doldurulmayacak! Değeri almak için '/listSecrets' POST isteğini kullanın. string

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. string
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 string

Hızlı başlangıç şablonları

Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.

Şablon Description
API Management kaynağı olan Front Door Standard/Premium

Azure’a dağıtın
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ı

Hizmet/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 aşağıdaki Terraform'u şablonunuza ekleyin.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/namedValues@2023-05-01-preview"
  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@2023-05-01-preview"
name Kaynak adı dize (gerekli)
parent_id Bu kaynağın üst öğesi olan kaynağın kimliği. Kaynak türü: hizmet kimliği
properties 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)
keyVault AdlıDeğer'in KeyVault konum ayrıntıları. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
gizli dizi 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. dize[]
değer NamedValue değeri. İlke ifadeleri içerebilir. Boş olmayabilir veya yalnızca boşluklardan oluşamayabilir. Bu özellik 'GET' işlemlerinde doldurulmayacak! Değeri almak için '/listSecrets' POST isteğini kullanın. string

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. string
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 string