az apim product

Başvuru

Azure API Management Ürününü yönetme.

Komutlar

az apim product api	Azure API Management Ürününün API'lerini yönetme.
az apim product api add	Belirtilen ürüne bir API ekleyin.
az apim product api check	Tanımlayıcı tarafından belirtilen API varlığının Product varlığıyla ilişkilendirildiğini denetler.
az apim product api delete	Belirtilen API'yi belirtilen üründen siler.
az apim product api list	Bir ürünle ilişkili API'lerin koleksiyonunu listeler.
az apim product create	Bir ürün oluşturur.
az apim product delete	Ürünü silin.
az apim product list	Belirtilen hizmet örneğindeki bir ürün koleksiyonunu listeler.
az apim product show	Tanımlayıcısı tarafından belirtilen ürünün ayrıntılarını alır.
az apim product update	Mevcut ürün ayrıntılarını güncelleştirin.
az apim product wait	APIM ürününün bir koşulu karşılanıncaya kadar CLI'yi bekleme durumuna yerleştirin.

az apim product create

Düzenle

Bir ürün oluşturur.

az apim product create --product-name
                       --resource-group
                       --service-name
                       [--approval-required {false, true}]
                       [--description]
                       [--legal-terms]
                       [--no-wait]
                       [--product-id]
                       [--state {notPublished, published}]
                       [--subscription-required {false, true}]
                       [--subscriptions-limit]

Örnekler

Bir ürün oluşturur.

az apim product create --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyProductName --description MyDescription --legal-terms MyTerms --subscription-required true --approval-required true --subscriptions-limit 8 --state "published"

Gerekli Parametreler

--product-name

Ürün adı.

--resource-group -g

Kaynak grubunun adı. kullanarak varsayılan grubu az configure --defaults group=<name>yapılandırabilirsiniz.

--service-name -n

Api management hizmet örneğinin adı.

İsteğe Bağlı Parametreler

--approval-required

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.

kabul edilen değerler: false, true

--description

Ürün açıklaması. HTML biçimlendirme etiketlerini içerebilir.

--legal-terms

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

--no-wait

Uzun süre çalışan işlemin bitmesini beklemeyin.

--product-id

Ürün tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.

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

kabul edilen değerler: notPublished, published

--subscription-required -s

Bu ürüne dahil edilen API'lere erişmek için bir ürün aboneliği gerekip gerekmediği.

kabul edilen değerler: false, true

--subscriptions-limit

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.

Global Parametreler

--debug

Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.

--help -h

Bu yardım iletisini göster ve çık.

--only-show-errors

Yalnızca hataları gösterir, uyarıları gizler.

--output -o

Çıkış biçimi.

--query

JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz http://jmespath.org/ .

--subscription

Aboneliğin adı veya kimliği. varsayılan aboneliğini kullanarak az account set -s NAME_OR_IDyapılandırabilirsiniz.

--verbose

Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.

az apim product delete

Düzenle

Ürünü silin.

az apim product delete --product-id
                       --resource-group
                       --service-name
                       [--delete-subscriptions]
                       [--if-match]
                       [--no-wait]
                       [--yes]

Örnekler

Bu ürünün tüm aboneliklerini içeren ürünü silin.

az apim product delete --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --delete-subscriptions true

Gerekli Parametreler

--product-id

Ürün tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.

--resource-group -g

Kaynak grubunun adı. kullanarak varsayılan grubu az configure --defaults group=<name>yapılandırabilirsiniz.

--service-name -n

Api management hizmet örneğinin adı.

İsteğe Bağlı Parametreler

--delete-subscriptions

Ürünle ilişkili mevcut abonelikleri silin veya silin.

--if-match

Varlığın ETag'i.

--no-wait

Uzun süre çalışan işlemin bitmesini beklemeyin.

--yes -y

Onay isteminde bulunmayın.

Global Parametreler

--debug

Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.

--help -h

Bu yardım iletisini göster ve çık.

--only-show-errors

Yalnızca hataları gösterir, uyarıları gizler.

--output -o

Çıkış biçimi.

--query

JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz http://jmespath.org/ .

--subscription

Aboneliğin adı veya kimliği. varsayılan aboneliğini kullanarak az account set -s NAME_OR_IDyapılandırabilirsiniz.

--verbose

Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.

az apim product list

Düzenle

Belirtilen hizmet örneğindeki bir ürün koleksiyonunu listeler.

az apim product list --resource-group
                     --service-name

Örnekler

Bu APIM örneği için tüm ürünleri listeleyin.

az apim product list --resource-group MyResourceGroup --service-name MyServiceName

Gerekli Parametreler

--resource-group -g

Kaynak grubunun adı. kullanarak varsayılan grubu az configure --defaults group=<name>yapılandırabilirsiniz.

--service-name -n

Api management hizmet örneğinin adı.

Global Parametreler

--debug

Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.

--help -h

Bu yardım iletisini göster ve çık.

--only-show-errors

Yalnızca hataları gösterir, uyarıları gizler.

--output -o

Çıkış biçimi.

--query

JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz http://jmespath.org/ .

--subscription

Aboneliğin adı veya kimliği. varsayılan aboneliğini kullanarak az account set -s NAME_OR_IDyapılandırabilirsiniz.

--verbose

Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.

az apim product show

Düzenle

Tanımlayıcısı tarafından belirtilen ürünün ayrıntılarını alır.

az apim product show --product-id
                     --resource-group
                     --service-name

Örnekler

Tanımlayıcısı tarafından belirtilen ürünün ayrıntılarını alır.

az apim product show --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID

Gerekli Parametreler

--product-id

Ürün tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.

--resource-group -g

Kaynak grubunun adı. kullanarak varsayılan grubu az configure --defaults group=<name>yapılandırabilirsiniz.

--service-name -n

Api management hizmet örneğinin adı.

Global Parametreler

--debug

Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.

--help -h

Bu yardım iletisini göster ve çık.

--only-show-errors

Yalnızca hataları gösterir, uyarıları gizler.

--output -o

Çıkış biçimi.

--query

JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz http://jmespath.org/ .

--subscription

Aboneliğin adı veya kimliği. varsayılan aboneliğini kullanarak az account set -s NAME_OR_IDyapılandırabilirsiniz.

--verbose

Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.

az apim product update

Düzenle

Mevcut ürün ayrıntılarını güncelleştirin.

az apim product update --product-id
                       --resource-group
                       --service-name
                       [--add]
                       [--approval-required {false, true}]
                       [--description]
                       [--force-string]
                       [--if-match]
                       [--legal-terms]
                       [--no-wait]
                       [--product-name]
                       [--remove]
                       [--set]
                       [--state {notPublished, published}]
                       [--subscription-required {false, true}]
                       [--subscriptions-limit]

Örnekler

Mevcut ürün ayrıntılarını güncelleştirin.

az apim product update --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyNewProductName --description MyNewDescription --legal-terms MyNewTerms --subscription-required false --state "notPublished"

Gerekli Parametreler

--product-id

Ürün tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.

--resource-group -g

Kaynak grubunun adı. kullanarak varsayılan grubu az configure --defaults group=<name>yapılandırabilirsiniz.

--service-name -n

Api management hizmet örneğinin adı.

İsteğe Bağlı Parametreler

--add

Bir yol ve anahtar değer çiftleri belirterek nesne listesine nesne ekleyin. Örnek: --add property.listProperty <key=value, string veya JSON string>.

--approval-required

kabul edilen değerler: false, true

--description

Ürün açıklaması. HTML biçimlendirme etiketlerini içerebilir.

--force-string

'set' veya 'add' kullanırken, JSON'a dönüştürmeye çalışmak yerine dize değişmez değerlerini koruyun.

--if-match

Varlığın ETag'i.

--legal-terms

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

--no-wait

Uzun süre çalışan işlemin bitmesini beklemeyin.

--product-name

Ürün adı.

--remove

Bir özelliği veya öğeyi listeden kaldırın. Örnek: --remove property.list OR --remove propertyToRemove.

--set

Ayarlanacağı özellik yolunu ve değerini belirterek bir nesneyi güncelleştirin. Örnek: --set property1.property2=.

--state

kabul edilen değerler: notPublished, published

--subscription-required -s

Bu ürüne dahil edilen API'lere erişmek için bir ürün aboneliği gerekip gerekmediği.

kabul edilen değerler: false, true

--subscriptions-limit

Global Parametreler

--debug

Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.

--help -h

Bu yardım iletisini göster ve çık.

--only-show-errors

Yalnızca hataları gösterir, uyarıları gizler.

--output -o

Çıkış biçimi.

--query

JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz http://jmespath.org/ .

--subscription

Aboneliğin adı veya kimliği. varsayılan aboneliğini kullanarak az account set -s NAME_OR_IDyapılandırabilirsiniz.

--verbose

Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.

az apim product wait

Düzenle

APIM ürününün bir koşulu karşılanıncaya kadar CLI'yi bekleme durumuna yerleştirin.

az apim product wait --product-id
                     --resource-group
                     --service-name
                     [--created]
                     [--custom]
                     [--deleted]
                     [--exists]
                     [--interval]
                     [--timeout]
                     [--updated]

Örnekler

BIR apim koşulu karşılanıncaya kadar CLI'yi bekleme durumuna yerleştirin. (otomatik olarak oluşturulmuş)

az apim product wait --created --resource-group MyResourceGroup --service-name MyServiceName --product-id MyProductID

Gerekli Parametreler

--product-id

Ürün tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.

--resource-group -g

Kaynak grubunun adı. kullanarak varsayılan grubu az configure --defaults group=<name>yapılandırabilirsiniz.

--service-name -n

Api management hizmet örneğinin adı.

İsteğe Bağlı Parametreler

--created

'provisioningState' ile 'Succeeded' konumunda oluşturulana kadar bekleyin.

--custom

Koşul özel bir JMESPath sorgusunu karşılayana kadar bekleyin. Örneğin provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Silinene kadar bekleyin.

--exists

Kaynak var olana kadar bekleyin.

--interval

Saniye cinsinden yoklama aralığı.

varsayılan değer: 30

--timeout

Saniye cinsinden maksimum bekleme.

varsayılan değer: 3600

--updated

provisioningState değeri 'Başarılı' olarak güncelleştirilene kadar bekleyin.

Global Parametreler

--debug

Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.

--help -h

Bu yardım iletisini göster ve çık.

--only-show-errors

Yalnızca hataları gösterir, uyarıları gizler.

--output -o

Çıkış biçimi.

--query

JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz http://jmespath.org/ .

--subscription

Aboneliğin adı veya kimliği. varsayılan aboneliğini kullanarak az account set -s NAME_OR_IDyapılandırabilirsiniz.

--verbose

Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.