Aracılığıyla paylaş

Microsoft.ApiManagement hizmeti/çalışma alanları/namedValues 2023-03-01-preview

  • Makale

Bicep kaynak tanımı

Hizmet/çalışma alanları/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/workspaces/namedValues kaynağı oluşturmak için şablonunuza aşağıdaki Bicep'i ekleyin.

resource symbolicname 'Microsoft.ApiManagement/service/workspaces/namedValues@2023-03-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    displayName: 'string'
    keyVault: {
      identityClientId: 'string'
      secretIdentifier: 'string'
    }
    secret: bool
    tags: [
      'string'
    ]
    value: 'string'
  }
}

Özellik değerleri

service/workspaces/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 alt kaynak için üst kaynağı 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.		 Kaynak türü için sembolik ad: çalışma alanları
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

ARM şablonu kaynak tanımı

Hizmet/çalışma alanları/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/workspaces/namedValues kaynağı oluşturmak için şablonunuza aşağıdaki JSON dosyasını ekleyin.

{
  "type": "Microsoft.ApiManagement/service/workspaces/namedValues",
  "apiVersion": "2023-03-01-preview",
  "name": "string",
  "properties": {
    "displayName": "string",
    "keyVault": {
      "identityClientId": "string",
      "secretIdentifier": "string"
    },
    "secret": "bool",
    "tags": [ "string" ],
    "value": "string"
  }
}

Özellik değerleri

service/workspaces/namedValues

Ad Açıklama Değer
tür Kaynak türü 'Microsoft.ApiManagement/service/workspaces/namedValues'
apiVersion Kaynak API'sinin sürümü '2023-03-01-preview'
name Kaynak adı

JSON ARM şablonlarında alt kaynaklar için adları ve türleri ayarlamayı öğrenin.		 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

Terraform (AzAPI sağlayıcısı) kaynak tanımı

Hizmet/çalışma alanları/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/workspaces/namedValues kaynağı oluşturmak için şablonunuza aşağıdaki Terraform'u ekleyin.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/workspaces/namedValues@2023-03-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/workspaces/namedValues

Ad Açıklama Değer
tür Kaynak türü "Microsoft.ApiManagement/service/workspaces/namedValues@2023-03-01-preview"
name Kaynak adı dize (gerekli)
parent_id Bu kaynağın üst öğesi olan kaynağın kimliği. Kaynak türü: çalışma alanları 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