Microsoft.ApiManagement hizmeti/ürünleri 2021-08-01
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@2021-08-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
approvalRequired: bool
description: 'string'
displayName: 'string'
state: 'string'
subscriptionRequired: bool
subscriptionsLimit: int
terms: 'string'
}
}
Özellik değerleri
hizmet/ürünler
| Ad | Açıklama | Değer |
|---|---|---|
| ad | Kaynak adı Bicep'nde alt kaynaklar için adları ve türleri ayarlamayı öğrenin. |
dize (gerekli) Karakter sınırı: 1-80 Geçerli karakterler: Alfasayısallar ve kısa çizgiler. Harfle başlayın ve alfasayısal ile bitirin. |
| 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 |
| displayName | Ürün adı. | dize (gerekli) Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 300 |
| 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 |
Hızlı başlangıç şablonları
Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.
| Şablon | Açıklama |
|---|---|
Şablon kullanarak API Management örneği ve tüm alt kaynakları oluşturma
'a dağıtma |
Bu şablon, API Management hizmeti oluşturma ve alt varlıkları yapılandırma adımlarını gösterir |
|
Azure API Management önünde Azure Front Door oluşturma
'a dağıtma |
Bu örnek, Azure API Management'ın önünde genel yük dengeleyici olarak Azure Front Door'un nasıl kullanılacağını gösterir. |
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": "2021-08-01",
"name": "string",
"properties": {
"approvalRequired": "bool",
"description": "string",
"displayName": "string",
"state": "string",
"subscriptionRequired": "bool",
"subscriptionsLimit": "int",
"terms": "string"
}
}
Özellik değerleri
hizmet/ürünler
| Ad | Açıklama | Değer |
|---|---|---|
| tür | Kaynak türü | 'Microsoft.ApiManagement/service/products' |
| apiVersion | Kaynak API'sinin sürümü | '2021-08-01' |
| ad | Kaynak adı |
dize (gerekli) Karakter sınırı: 1-80 Geçerli karakterler: Alfasayısallar ve kısa çizgiler. Harfle başlayın ve alfasayısal ile bitirin. |
| Ö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 |
| displayName | Ürün adı. | dize (gerekli) Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 300 |
| 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 |
Hızlı başlangıç şablonları
Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.
| Şablon | Açıklama |
|---|---|
|
Şablon kullanarak API Management örneği ve tüm alt kaynakları oluşturma
'a dağıtma |
Bu şablon, API Management hizmeti oluşturma ve alt varlıkları yapılandırma adımlarını gösterir |
|
Azure API Management önünde Azure Front Door oluşturma
'a dağıtma |
Bu örnek, Azure API Management'ın önünde genel yük dengeleyici olarak Azure Front Door'un nasıl kullanılacağını gösterir. |
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@2021-08-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
approvalRequired = bool
description = "string"
displayName = "string"
state = "string"
subscriptionRequired = bool
subscriptionsLimit = int
terms = "string"
}
})
}
Özellik değerleri
hizmet/ürünler
| Ad | Açıklama | Değer |
|---|---|---|
| tür | Kaynak türü | "Microsoft.ApiManagement/service/products@2021-08-01" |
| ad | Kaynak adı | dize (gerekli) Karakter sınırı: 1-80 Geçerli karakterler: Alfasayısallar ve kısa çizgiler. Harfle başlayın ve alfasayısal ile bitirin. |
| 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 |
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 |
| displayName | Ürün adı. | dize (gerekli) Kısıtlama -ları: En az uzunluk = 1 Maksimum uzunluk = 300 |
| 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 |