Aracılığıyla paylaş

Microsoft.ApiManagement hizmeti/ürünleri

Bicep kaynak tanımı

Hizmet/ürünler 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/products kaynağı oluşturmak için şablonunuza aşağıdaki Bicep'i ekleyin.

resource symbolicname 'Microsoft.ApiManagement/service/products@2024-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    approvalRequired: bool
    description: 'string'
    displayName: 'string'
    state: 'string'
    subscriptionRequired: bool
    subscriptionsLimit: int
    terms: 'string'
  }
}

Özellik Değerleri

Microsoft.ApiManagement/service/products

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

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 256 (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 Ürün varlığı sözleşme özellikleri. ProductContractProperties

ProductContractProperties

Ad Açıklama Değer
approvalRequired abonelik onayı gerekip gerekmediği. Yanlışsa, yeni abonelikler otomatik olarak onaylanır ve geliştiriciler abone olduktan hemen sonra ürünün API'lerini çağırabilir. Doğruysa, geliştiricilerin ürünün API'lerinden birini kullanabilmesi için önce yöneticilerin aboneliği el ile onaylaması gerekir. Yalnızca subscriptionRequired özelliği mevcutsa ve false değerine sahipse mevcut olabilir. Bool
Açıklama Ürün açıklaması. HTML biçimlendirme etiketleri içerebilir. dizgi

Kısıtlama -ları:
Maksimum uzunluk = 1000
ekran adı Ürün adı. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 300 (gerekli)
devlet ürünün yayımlanıp yayımlanmadığı. Yayımlanan ürünler geliştirici portalı kullanıcıları tarafından bulunabilir. Yayımlanmayan ürünler yalnızca yöneticiler tarafından görülebilir. Ürün'ün varsayılan durumu Yayımlanmadı. 'notPublished'
'yayımlandı'
subscriptionRequired Bu ürüne dahil edilen API'lere erişmek için bir ürün aboneliği gerekip gerekmediği. Doğruysa, ürün "korumalı" olarak adlandırılır ve ürüne dahil edilen bir API'ye yapılan isteğin başarılı olması için geçerli bir abonelik anahtarı gerekir. Yanlışsa, ürün "açık" olarak adlandırılır ve ürüne dahil olan bir API'ye yönelik istekler abonelik anahtarı olmadan yapılabilir. Yeni bir ürün oluşturulurken özellik atlanırsa değerinin true olduğu varsayılır. Bool
subscriptionsLimit Bir kullanıcının bu ürüne aynı anda sahip olabileceği abonelik sayısının olup olmadığı. Kullanıcı başına sınırsız aboneliğe izin vermek için null veya atla olarak ayarlayın. Yalnızca subscriptionRequired özelliği mevcutsa ve false değerine sahipse mevcut olabilir. Int
Terim Ürün kullanım koşulları. Ürüne abone olmaya çalışan geliştiriciler, abonelik sürecini tamamlamadan önce bu koşulları kabul etmek için sunulur ve gereklidir. dizgi

ARM şablonu kaynak tanımı

Hizmet/ürünler 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/products kaynağı oluşturmak için şablonunuza aşağıdaki JSON'u ekleyin.

{
  "type": "Microsoft.ApiManagement/service/products",
  "apiVersion": "2024-06-01-preview",
  "name": "string",
  "properties": {
    "approvalRequired": "bool",
    "description": "string",
    "displayName": "string",
    "state": "string",
    "subscriptionRequired": "bool",
    "subscriptionsLimit": "int",
    "terms": "string"
  }
}

Özellik Değerleri

Microsoft.ApiManagement/service/products

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

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 256 (gerekli)
Özellikler Ürün varlığı sözleşme özellikleri. ProductContractProperties
tür Kaynak türü 'Microsoft.ApiManagement/service/products'

ProductContractProperties

Ad Açıklama Değer
approvalRequired abonelik onayı gerekip gerekmediği. Yanlışsa, yeni abonelikler otomatik olarak onaylanır ve geliştiriciler abone olduktan hemen sonra ürünün API'lerini çağırabilir. Doğruysa, geliştiricilerin ürünün API'lerinden birini kullanabilmesi için önce yöneticilerin aboneliği el ile onaylaması gerekir. Yalnızca subscriptionRequired özelliği mevcutsa ve false değerine sahipse mevcut olabilir. Bool
Açıklama Ürün açıklaması. HTML biçimlendirme etiketleri içerebilir. dizgi

Kısıtlama -ları:
Maksimum uzunluk = 1000
ekran adı Ürün adı. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 300 (gerekli)
devlet ürünün yayımlanıp yayımlanmadığı. Yayımlanan ürünler geliştirici portalı kullanıcıları tarafından bulunabilir. Yayımlanmayan ürünler yalnızca yöneticiler tarafından görülebilir. Ürün'ün varsayılan durumu Yayımlanmadı. 'notPublished'
'yayımlandı'
subscriptionRequired Bu ürüne dahil edilen API'lere erişmek için bir ürün aboneliği gerekip gerekmediği. Doğruysa, ürün "korumalı" olarak adlandırılır ve ürüne dahil edilen bir API'ye yapılan isteğin başarılı olması için geçerli bir abonelik anahtarı gerekir. Yanlışsa, ürün "açık" olarak adlandırılır ve ürüne dahil olan bir API'ye yönelik istekler abonelik anahtarı olmadan yapılabilir. Yeni bir ürün oluşturulurken özellik atlanırsa değerinin true olduğu varsayılır. Bool
subscriptionsLimit Bir kullanıcının bu ürüne aynı anda sahip olabileceği abonelik sayısının olup olmadığı. Kullanıcı başına sınırsız aboneliğe izin vermek için null veya atla olarak ayarlayın. Yalnızca subscriptionRequired özelliği mevcutsa ve false değerine sahipse mevcut olabilir. Int
Terim Ürün kullanım koşulları. Ürüne abone olmaya çalışan geliştiriciler, abonelik sürecini tamamlamadan önce bu koşulları kabul etmek için sunulur ve gereklidir. dizgi

Kullanım Örnekleri

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

Hizmet/ürünler 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/products kaynağı oluşturmak için şablonunuza aşağıdaki Terraform'u ekleyin.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/products@2024-06-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      approvalRequired = bool
      description = "string"
      displayName = "string"
      state = "string"
      subscriptionRequired = bool
      subscriptionsLimit = int
      terms = "string"
    }
  }
}

Özellik Değerleri

Microsoft.ApiManagement/service/products

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

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 256 (gerekli)
parent_id Bu kaynağın üst öğesi olan kaynağın kimliği. Kaynak türü için kimlik: hizmet
Özellikler Ürün varlığı sözleşme özellikleri. ProductContractProperties
tür Kaynak türü "Microsoft.ApiManagement/service/products@2024-06-01-preview"

ProductContractProperties

Ad Açıklama Değer
approvalRequired abonelik onayı gerekip gerekmediği. Yanlışsa, yeni abonelikler otomatik olarak onaylanır ve geliştiriciler abone olduktan hemen sonra ürünün API'lerini çağırabilir. Doğruysa, geliştiricilerin ürünün API'lerinden birini kullanabilmesi için önce yöneticilerin aboneliği el ile onaylaması gerekir. Yalnızca subscriptionRequired özelliği mevcutsa ve false değerine sahipse mevcut olabilir. Bool
Açıklama Ürün açıklaması. HTML biçimlendirme etiketleri içerebilir. dizgi

Kısıtlama -ları:
Maksimum uzunluk = 1000
ekran adı Ürün adı. dizgi

Kısıtlama -ları:
En az uzunluk = 1
Maksimum uzunluk = 300 (gerekli)
devlet ürünün yayımlanıp yayımlanmadığı. Yayımlanan ürünler geliştirici portalı kullanıcıları tarafından bulunabilir. Yayımlanmayan ürünler yalnızca yöneticiler tarafından görülebilir. Ürün'ün varsayılan durumu Yayımlanmadı. 'notPublished'
'yayımlandı'
subscriptionRequired Bu ürüne dahil edilen API'lere erişmek için bir ürün aboneliği gerekip gerekmediği. Doğruysa, ürün "korumalı" olarak adlandırılır ve ürüne dahil edilen bir API'ye yapılan isteğin başarılı olması için geçerli bir abonelik anahtarı gerekir. Yanlışsa, ürün "açık" olarak adlandırılır ve ürüne dahil olan bir API'ye yönelik istekler abonelik anahtarı olmadan yapılabilir. Yeni bir ürün oluşturulurken özellik atlanırsa değerinin true olduğu varsayılır. Bool
subscriptionsLimit Bir kullanıcının bu ürüne aynı anda sahip olabileceği abonelik sayısının olup olmadığı. Kullanıcı başına sınırsız aboneliğe izin vermek için null veya atla olarak ayarlayın. Yalnızca subscriptionRequired özelliği mevcutsa ve false değerine sahipse mevcut olabilir. Int
Terim Ürün kullanım koşulları. Ürüne abone olmaya çalışan geliştiriciler, abonelik sürecini tamamlamadan önce bu koşulları kabul etmek için sunulur ve gereklidir. dizgi