Microsoft.ApiManagement service/products 2022-04-01-preview
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@2022-04-01-preview' = {
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 |
---|---|---|
name | Kaynak adı Bicep'te 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. |
Ü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. |
Şu tür kaynak için sembolik ad: hizmet |
properties | Ürün varlığı sözleşme özellikleri. | ProductContractProperties |
ProductContractProperties
Ad | Açıklama | Değer |
---|---|---|
approvalRequired | abonelik onayı gerekip gerekmediği. False ise 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. | string |
displayName | Ürün adı. | dize (gerekli) |
state | ü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. False ise, ürün "açık" olarak adlandırılır ve ürüne dahil edilen bir API'ye yönelik istekler abonelik anahtarı olmadan yapılabilir. Yeni bir ürün oluşturulurken özellik atlanırsa değerin 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 at 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 işlemini tamamlamadan önce bu koşulları kabul etmek için sunulacaktır. | string |
Hızlı başlangıç şablonları
Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.
Şablon | Description |
---|---|
Şablon kullanarak bir API Management örneği ve alt kaynaklarını oluşturma |
Bu şablonda API Management hizmeti oluşturma ve alt varlıkları yapılandırma işlemleri gösterilmektedir |
Azure API Management önünde Azure Front Door oluşturma |
Bu örnekte, Azure Front Door'un Azure API Management önünde küresel yük dengeleyici olarak nasıl kullanılacağı gösterilmektedir. |
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": "2022-04-01-preview",
"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ü | '2022-04-01-preview' |
name | Kaynak adı Bkz. JSON ARM şablonlarında alt kaynaklar için adları ve türleri ayarlama. |
dize (gerekli) Karakter sınırı: 1-80 Geçerli karakterler: Alfasayısal değerler ve kısa çizgiler. Harfle başlayın ve alfasayısal ile bitirin. |
properties | Ü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ştiricinin ürünün API'lerinden birini kullanabilmesi için önce yöneticilerin aboneliği el ile onaylaması gerekir. Yalnızca subscriptionRequired özelliği varsa ve false değerine sahipse mevcut olabilir. | bool |
açıklama | Ürün açıklaması. HTML biçimlendirme etiketlerini içerebilir. | string |
displayName | Ürün adı. | dize (gerekli) |
state | ü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. True ise, ü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. False ise ürün "açık" olarak adlandırılır ve ürüne dahil edilen API'ye yönelik istekler abonelik anahtarı olmadan yapılabilir. Yeni bir ürün oluşturulurken özellik atlanırsa değerin 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 varsa ve false değerine sahipse mevcut olabilir. | int |
Terim | Ürün kullanım koşulları. Ürüne abone olmaya çalışan geliştiriciler sunulur ve abonelik işlemini tamamlamadan önce bu koşulları kabul etmeleri 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 |
---|---|
Şablon kullanarak bir API Management örneği ve alt kaynaklarını oluşturma |
Bu şablonda API Management hizmeti oluşturma ve alt varlıkları yapılandırma işlemleri gösterilir |
Azure API Management önünde Azure Front Door oluşturma |
Bu örnekte Azure Front Door'un Azure API Management önünde genel yük dengeleyici olarak nasıl kullanılacağı gösterilmektedir. |
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@2022-04-01-preview"
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@2022-04-01-preview" |
name | Kaynak adı | dize (gerekli) Karakter sınırı: 1-80 Geçerli karakterler: Alfasayısal değerler 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ü: hizmet kimliği |
properties | Ü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ştiricinin ürünün API'lerinden birini kullanabilmesi için önce yöneticilerin aboneliği el ile onaylaması gerekir. Yalnızca subscriptionRequired özelliği varsa ve false değerine sahipse mevcut olabilir. | bool |
açıklama | Ürün açıklaması. HTML biçimlendirme etiketlerini içerebilir. | string |
displayName | Ürün adı. | dize (gerekli) |
state | ü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. True ise, ü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. False ise ürün "açık" olarak adlandırılır ve ürüne dahil edilen API'ye yönelik istekler abonelik anahtarı olmadan yapılabilir. Yeni bir ürün oluşturulurken özellik atlanırsa değerin 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 varsa ve false değerine sahipse mevcut olabilir. | int |
Terim | Ürün kullanım koşulları. Ürüne abone olmaya çalışan geliştiriciler sunulur ve abonelik işlemini tamamlamadan önce bu koşulları kabul etmeleri gerekir. | string |