az apim

Başvuru

Azure API Management hizmetlerini yönetme.

Komutlar

az apim api	Azure API Management API'lerini yönetin.
az apim api create	bir API Management API'si oluşturun.
az apim api delete	API Management API'lerini silin.
az apim api import	API Management API'lerini içeri aktarma.
az apim api list	API MANAGEMENT API'lerini listeleyin.
az apim api operation	Azure API Management API İşlemlerini yönetme.
az apim api operation create	API'de yeni bir işlem oluşturur.
az apim api operation delete	API'de belirtilen işlemi siler.
az apim api operation list	Belirtilen API için işlemlerin bir koleksiyonunu listeleyin.
az apim api operation show	Tanımlayıcısı tarafından belirtilen API İşleminin ayrıntılarını alır.
az apim api operation update	api'de tanımlayıcısı tarafından belirtilen işlemin ayrıntılarını Güncelleştirmeler.
az apim api release	Azure API Management API Yayınını yönetme.
az apim api release create	API için yeni bir Yayın oluşturur.
az apim api release delete	API'de belirtilen sürümü siler.
az apim api release list	BIR API'nin tüm sürümlerini listeler.
az apim api release show	API sürümünün ayrıntılarını döndürür.
az apim api release update	Tanımlayıcısı tarafından belirtilen API sürümünün ayrıntılarını Güncelleştirmeler.
az apim api revision	Azure API Management API Düzeltmesi'ne bakın.
az apim api revision create	API düzeltmesi oluşturma.
az apim api revision list	API'nin tüm düzeltmelerini listeler.
az apim api schema	Azure API Management API Şemalarını yönetin.
az apim api schema create	API Management API Şeması oluşturun.
az apim api schema delete	API Management API Şemasını silin.
az apim api schema get-etag	API Management API şemasının etag'ini alın.
az apim api schema list	API MANAGEMENT API şemalarını listeleyin.
az apim api schema show	API Management API Şemasının ayrıntılarını gösterir.
az apim api schema wait	Apim api şeması koşulu karşılanıncaya kadar CLI'yi bekleme durumuna yerleştirin.
az apim api show	API Management API'sinin ayrıntılarını gösterme.
az apim api update	API Management API'sini güncelleştirme.
az apim api versionset	Azure API Management API Sürüm Kümesini yönetme.
az apim api versionset create	Api Sürüm Kümesi oluşturur.
az apim api versionset delete	Belirli api sürüm kümesini siler.
az apim api versionset list	Belirtilen hizmet örneğindeki API Sürüm Kümeleri koleksiyonunu listeler.
az apim api versionset show	Tanımlayıcısı tarafından belirtilen Api Sürüm Kümesinin ayrıntılarını alır.
az apim api versionset update	Tanımlayıcısı tarafından belirtilen Api VersionSet'in ayrıntılarını Güncelleştirmeler.
az apim api wait	APIM API'sinin koşulu karşılanıncaya kadar CLI'yi bekleme durumuna yerleştirin.
az apim apply-network-updates	Güncelleştirilmiş ağ ayarlarını seçmek için sanal ağda çalışan API Management kaynağını güncelleştirin.
az apim backup	verilen Azure Depolama Hesabına API Management hizmetinin bir yedeğini oluşturur. Bu uzun süre çalışan bir işlemdir ve tamamlanması birkaç dakika sürebilir.
az apim check-name	Hizmet adının kullanılabilir olup olmadığını denetler.
az apim create	bir API Management hizmet örneği oluşturun.
az apim delete	bir API Management hizmetini siler.
az apim deletedservice	Geçici olarak silinen Azure API Management hizmetlerini yönetme.
az apim deletedservice list	Belirli bir abonelik için geri alınabilecek tüm geçici silinmiş Api Management hizmetleri örneklerini listeleyin.
az apim deletedservice purge	Geçici olarak silinen Api Management hizmet örneğini temizleme (silme seçeneği olmadan siler).
az apim deletedservice show	Geçici olarak silinen Api Management hizmet örneklerini ada göre geri almak için kullanılabilir.
az apim list	Hizmet örneklerini API Management listeleyin.
az apim nv	Azure API Management Adlandırılmış Değerlerini yönetme.
az apim nv create	adlandırılmış API Management değeri oluşturun.
az apim nv delete	adlandırılmış API Management değerini silin.
az apim nv list	Adlandırılmış Değerleri API Management listeleyin.
az apim nv show	adlandırılmış API Management değerinin ayrıntılarını gösterir.
az apim nv show-secret	adlandırılmış bir API Management değerinin gizli dizisini alır.
az apim nv update	adlandırılmış API Management değerini güncelleştirin.
az apim nv wait	Değer adlı apim koşulu karşılanıncaya kadar CLI'yi bekleme durumuna yerleştirin.
az apim product	Azure API Management Ürününü yönetme.
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 restore	Geçerli hizmette ApiManagementService_Backup işlemi kullanılarak oluşturulan bir API Management hizmetinin yedeğini geri yükler. Bu uzun süre çalışan bir işlemdir ve tamamlanması birkaç dakika sürebilir.
az apim show	API Management hizmet örneğinin ayrıntılarını gösterin.
az apim update	API Management hizmet örneğini güncelleştirme.
az apim wait	APIM'nin bir koşulu karşılanıncaya kadar CLI'yi bekleme durumuna yerleştirin.

az apim apply-network-updates

Düzenle

Güncelleştirilmiş ağ ayarlarını seçmek için sanal ağda çalışan API Management kaynağını güncelleştirin.

az apim apply-network-updates --name
                              --resource-group
                              [--location]
                              [--no-wait]

Örnekler

API Management hizmet örneğinin sanal ağ ayarlarını güncelleştirme

az apim apply-network-updates --name MyApim -g MyResourceGroup

Gerekli Parametreler

--name -n

Api management hizmet örneğinin adı.

--resource-group -g

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

İsteğe Bağlı Parametreler

--location -l

Konum. Değerleri: az account list-locations. varsayılan konumu kullanarak az configure --defaults location=<location>yapılandırabilirsiniz.

--no-wait

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

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öster, uyarıları gizle.

--output -o

Çıkış biçimi.

--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak varsayılan aboneliği 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 backup

Düzenle

verilen Azure Depolama Hesabına API Management hizmetinin bir yedeğini oluşturur. Bu uzun süre çalışan bir işlemdir ve tamamlanması birkaç dakika sürebilir.

az apim backup --backup-name
               --container-name
               --name
               --resource-group
               --storage-account-key
               --storage-account-name
               [--no-wait]

Örnekler

API Management hizmet örneğinin yedeğini oluşturma

az apim backup --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

Gerekli Parametreler

--backup-name

Oluşturulacak yedekleme dosyasının adı.

--container-name --storage-account-container

Yedeklemeyi yerleştirmek için kullanılan depolama hesabı kapsayıcısının adı.

--name -n

Api management hizmet örneğinin adı.

--resource-group -g

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

--storage-account-key

Yedeklemeyi yerleştirmek için kullanılan depolama hesabının erişim anahtarı.

--storage-account-name

Yedeklemeyi yerleştirmek için kullanılan depolama hesabının adı.

İsteğe Bağlı Parametreler

--no-wait

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

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öster, uyarıları gizle.

--output -o

Çıkış biçimi.

--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak varsayılan aboneliği 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 check-name

Düzenle

Hizmet adının kullanılabilir olup olmadığını denetler.

az apim check-name --name

Gerekli Parametreler

--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öster, uyarıları gizle.

--output -o

Çıkış biçimi.

--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak varsayılan aboneliği 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 create

Düzenle

bir API Management hizmet örneği oluşturun.

az apim create --name
               --publisher-email
               --publisher-name
               --resource-group
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--location]
               [--no-wait]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
               [--tags]
               [--virtual-network {External, Internal, None}]

Örnekler

Geliştirici katmanı API Management hizmeti oluşturun.

az apim create --name MyApim -g MyResourceGroup -l eastus --publisher-email email@mydomain.com --publisher-name Microsoft

Tüketim katmanı API Management hizmeti oluşturun.

az apim create --name MyApim -g MyResourceGroup -l eastus --sku-name Consumption --enable-client-certificate \
    --publisher-email email@mydomain.com --publisher-name Microsoft

Gerekli Parametreler

--name -n

Oluşturulacak hizmet örneğinin benzersiz adı.

--publisher-email

Tüm sistem bildirimlerini almak için e-posta adresi.

--publisher-name

Geliştirici portalında kullanılmak üzere kuruluşunuzun adı ve e-posta bildirimleri.

--resource-group -g

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

İsteğe Bağlı Parametreler

--enable-client-certificate

Her istekte ağ geçidine sunulmak üzere bir istemci sertifikası zorlar ve ayrıca ağ geçidindeki ilkede sertifikanın kimliğini doğrulama olanağı sağlar.

kabul edilen değerler: false, true

--enable-managed-identity

API Management hizmetinin diğer Azure kaynaklarına erişmesi için bir yönetilen kimlik oluşturun.

kabul edilen değerler: false, true

--location -l

Konum. Değerleri: az account list-locations. varsayılan konumu kullanarak az configure --defaults location=<location>yapılandırabilirsiniz.

--no-wait

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

--sku-capacity

SKU'nun dağıtılan birim sayısı.

varsayılan değer: 1

--sku-name

Api management örneğinin sku'su.

kabul edilen değerler: Basic, Consumption, Developer, Isolated, Premium, Standard

varsayılan değer: Developer

--tags

Boşlukla ayrılmış etiketler: key[=value] [key[=value] ...]. Mevcut etiketleri temizlemek için "" kullanın.

--virtual-network -v

Sanal ağ türü.

kabul edilen değerler: External, Internal, None

varsayılan değer: None

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öster, uyarıları gizle.

--output -o

Çıkış biçimi.

--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak varsayılan aboneliği 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 delete

Düzenle

bir API Management hizmetini siler.

az apim delete --name
               --resource-group
               [--no-wait]
               [--yes]

Örnekler

bir API Management hizmetini silin.

az apim delete -n MyApim -g MyResourceGroup

Gerekli Parametreler

--name -n

Api management hizmet örneğinin adı.

--resource-group -g

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

İsteğe Bağlı Parametreler

--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öster, uyarıları gizle.

--output -o

Çıkış biçimi.

--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak varsayılan aboneliği 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 list

Düzenle

Hizmet örneklerini API Management listeleyin.

az apim list [--resource-group]

İsteğe Bağlı Parametreler

--resource-group -g

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

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öster, uyarıları gizle.

--output -o

Çıkış biçimi.

--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak varsayılan aboneliği 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 restore

Düzenle

Geçerli hizmette ApiManagementService_Backup işlemi kullanılarak oluşturulan bir API Management hizmetinin yedeğini geri yükler. Bu uzun süre çalışan bir işlemdir ve tamamlanması birkaç dakika sürebilir.

az apim restore --backup-name
                --container-name
                --name
                --resource-group
                --storage-account-key
                --storage-account-name
                [--no-wait]

Örnekler

API Management hizmet örneğinin yedeğini geri yükler

az apim restore --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

Gerekli Parametreler

--backup-name

Geri yükleneceği yedekleme dosyasının adı.

--container-name --storage-account-container

Yedeklemeyi almak için kullanılan depolama hesabı kapsayıcısının adı.

--name -n

Api management hizmet örneğinin adı.

--resource-group -g

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

--storage-account-key

Yedeklemeyi almak için kullanılan depolama hesabının erişim anahtarı.

--storage-account-name

Yedeklemeyi almak için kullanılan depolama hesabının adı.

İsteğe Bağlı Parametreler

--no-wait

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

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öster, uyarıları gizle.

--output -o

Çıkış biçimi.

--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak varsayılan aboneliği 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 show

Düzenle

API Management hizmet örneğinin ayrıntılarını gösterin.

az apim show --name
             --resource-group

Gerekli Parametreler

--name -n

Api management hizmet örneğinin adı.

--resource-group -g

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

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öster, uyarıları gizle.

--output -o

Çıkış biçimi.

--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak varsayılan aboneliği 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 update

Düzenle

API Management hizmet örneğini güncelleştirme.

az apim update --name
               --resource-group
               [--add]
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--force-string]
               [--no-wait]
               [--publisher-email]
               [--publisher-name]
               [--remove]
               [--set]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
               [--tags]
               [--virtual-network {External, Internal, None}]

Gerekli Parametreler

--name -n

Api management hizmet örneğinin adı.

--resource-group -g

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

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

--enable-client-certificate

Her istekte ağ geçidine sunulmak üzere bir istemci sertifikası zorlar ve ayrıca ağ geçidindeki ilkede sertifikanın kimliğini doğrulama olanağı sağlar.

kabul edilen değerler: false, true

--enable-managed-identity

API Management hizmetinin diğer Azure kaynaklarına erişmesi için bir yönetilen kimlik oluşturun.

kabul edilen değerler: false, true

--force-string

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

--no-wait

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

--publisher-email

Tüm sistem bildirimlerini almak için e-posta adresi.

--publisher-name

Geliştirici portalında kullanılmak üzere kuruluşunuzun adı ve e-posta bildirimleri.

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

--sku-capacity

SKU'nun dağıtılan birim sayısı.

--sku-name

Api management örneğinin sku'su.

kabul edilen değerler: Basic, Consumption, Developer, Isolated, Premium, Standard

--tags

Boşlukla ayrılmış etiketler: key[=value] [key[=value] ...]. Mevcut etiketleri temizlemek için "" kullanın.

--virtual-network -v

Sanal ağ türü.

kabul edilen değerler: External, Internal, None

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öster, uyarıları gizle.

--output -o

Çıkış biçimi.

--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak varsayılan aboneliği 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 wait

Düzenle

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

az apim wait --name
             --resource-group
             [--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 wait --created --name MyApim --resource-group MyResourceGroup

Gerekli Parametreler

--name -n

Api management hizmet örneğinin adı.

--resource-group -g

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

İ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 en fazla 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öster, uyarıları gizle.

--output -o

Çıkış biçimi.

--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak varsayılan aboneliği 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.