az apim api

Başvuru

Azure API Management API'lerini yönetin.

Komutlar

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 api create

Düzenle

bir API Management API'si oluşturun.

az apim api create --api-id
                   --display-name
                   --path
                   --resource-group
                   --service-name
                   [--api-type {graphql, http, soap, websocket}]
                   [--authorization-scope]
                   [--authorization-server-id]
                   [--bearer-token-sending-methods]
                   [--description]
                   [--no-wait]
                   [--open-id-provider-id]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-key-required]
                   [--subscription-required {false, true}]

Örnekler

Temel bir API oluşturun.

az apim api create --service-name MyApim -g MyResourceGroup --api-id MyApi --path '/myapi' --display-name 'My API'

Gerekli Parametreler

--api-id

Oluşturulacak api'nin benzersiz adı.

--display-name

Oluşturulacak API'nin görünen adı.

--path

API yolu.

--resource-group -g

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

--service-name -n

API Management hizmet örneğinin adı.

İsteğe Bağlı Parametreler

--api-type

API'nin türü.

kabul edilen değerler: graphql, http, soap, websocket

--authorization-scope

OAuth işlemleri kapsamını belirtir.

--authorization-server-id

OAuth yetkilendirme sunucusu kimliğini belirtir.

--bearer-token-sending-methods

Taşıyıcı belirteci için gönderme yöntemlerini belirtir.

--description

API'nin açıklaması. HTML biçimlendirme etiketleri içerebilir.

--no-wait

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

--open-id-provider-id

Kimlik doğrulama ayarında openid değerini belirtir.

--protocols

Bu API'deki işlemlerin hangi protokollerde çağrılabileceğini açıklar.

kabul edilen değerler: http, https, ws, wss

--service-url

Bu API'yi uygulayan arka uç hizmetinin mutlak URL'si. 2000 karakterden uzun olamaz.

--subscription-key-header-name

Abonelik anahtarı üst bilgi adını belirtir.

--subscription-key-query-param-name

Abonelik anahtarı sorgu dizesi parametre adını belirtir.

--subscription-key-required

Bu API'ye çağrı sırasında abonelik anahtarının gerekip gerekmediğini belirtir, true - API yalnızca kapalı ürünlere dahil edilir, false - API yalnızca açık ürünlere dahil edilir, null ; ürünlerin bir karışımı vardır.

--subscription-required

True ise, API isteklerde bir abonelik anahtarı gerektirir.

kabul edilen değerler: false, true

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 api delete

Düzenle

API Management API'lerini silin.

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

Gerekli Parametreler

--api-id

API tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltmenin sonek olarak ;rev=n değeri vardır; burada n, düzeltme numarasıdır.

--resource-group -g

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

--service-name -n

API Management hizmet örneğinin adı.

İsteğe Bağlı Parametreler

--delete-revisions

Api'nin tüm düzeltmelerini silin.

--if-match

Varlığın ETag'i.

--no-wait

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

--yes -y

Onay istemde 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 api import

Düzenle

API Management API'lerini içeri aktarma.

az apim api import --path
                   --resource-group
                   --service-name
                   --specification-format {OpenApi, OpenApiJson, Swagger, Wadl, Wsdl}
                   [--api-id]
                   [--api-revision]
                   [--api-type {graphql, http, soap, websocket}]
                   [--api-version]
                   [--api-version-set-id]
                   [--description]
                   [--display-name]
                   [--no-wait]
                   [--protocols {http, https, ws, wss}]
                   [--service-url]
                   [--soap-api-type]
                   [--specification-path]
                   [--specification-url]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--wsdl-endpoint-name]
                   [--wsdl-service-name]

Örnekler

API Management API'lerini dosyadan veya URL'den içeri aktarma

az apim api import -g MyResourceGroup --service-name MyApim --path MyApi --specification-url https://MySpecificationURL --specification-format OpenApiJson

Gerekli Parametreler

--path

Gereklidir. Bu API'yi ve API Management hizmet örneği içindeki tüm kaynak yollarını benzersiz olarak tanımlayan göreli URL.

--resource-group -g

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

--service-name -n

Api management hizmet örneğinin adı.

--specification-format

İçeri aktarılan API'nin biçimini belirtin.

kabul edilen değerler: OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

İsteğe Bağlı Parametreler

--api-id

API tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltmenin sonek olarak ;rev=n değeri vardır; burada n, düzeltme numarasıdır.

--api-revision

Api'nin Düzeltmesini açıklar. Değer sağlanmazsa, varsayılan düzeltme 1 oluşturulur.

--api-type

API'nin türü.

kabul edilen değerler: graphql, http, soap, websocket

--api-version

Api'nin Sürümünü açıklar. Sürüm olmayan bir API'ye sürüm eklerseniz, Özgün sürüm otomatik olarak oluşturulur ve varsayılan URL'de yanıt verir.

--api-version-set-id

API ile kullanılacak Sürüm Kümesini açıklar.

--description

API'nin açıklaması. HTML biçimlendirme etiketleri içerebilir.

--display-name

Bu API'nin görünen adı.

--no-wait

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

--protocols

Bu API'deki işlemlerin hangi protokollerin (bir veya daha fazla) çağrılabileceğini açıklar.

kabul edilen değerler: http, https, ws, wss

--service-url

Bu API'yi uygulayan arka uç hizmetinin mutlak URL'si. 2000 karakterden uzun olamaz.

--soap-api-type

Dosya biçimi WSDL olduğunda API türü.

--specification-path

API'yi içeri aktarmak için belirtilen dosya yolu.

--specification-url

API'yi içeri aktarmak için belirtilen URL.

--subscription-key-header-name

Abonelik anahtarı üst bilgi adını belirtir.

--subscription-key-query-param-name

Abonelik anahtarı sorgu dizesi parametre adını belirtir.

--subscription-required

True ise, API isteklerde bir abonelik anahtarı gerektirir.

kabul edilen değerler: false, true

--wsdl-endpoint-name

İçeri aktarılacak WSDL Uç Noktasının (bağlantı noktası) yerel adı.

--wsdl-service-name

İçeri aktarılacak WSDL Hizmetinin yerel 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 api list

Düzenle

API MANAGEMENT API'lerini listeleyin.

az apim api list --resource-group
                 --service-name
                 [--filter-display-name]
                 [--skip]
                 [--top]

Gerekli Parametreler

--resource-group -g

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

--service-name -n

API Management hizmet örneğinin adı.

İsteğe Bağlı Parametreler

--filter-display-name

API'leri displayName'e göre filtreleyin.

--skip

Atacak kayıt sayısı.

--top

Döndürülecek kayıt sayısı.

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 api show

Düzenle

API Management API'sinin ayrıntılarını gösterme.

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

Gerekli Parametreler

--api-id

API tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltmenin sonek olarak ;rev=n değeri vardır; burada n, düzeltme numarasıdır.

--resource-group -g

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

--service-name

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 api update

Düzenle

API Management API'sini güncelleştirme.

az apim api update --api-id
                   --resource-group
                   --service-name
                   [--add]
                   [--api-type {graphql, http, soap, websocket}]
                   [--description]
                   [--display-name]
                   [--force-string]
                   [--if-match]
                   [--no-wait]
                   [--path]
                   [--protocols {http, https, ws, wss}]
                   [--remove]
                   [--service-url]
                   [--set]
                   [--subscription-key-header-name]
                   [--subscription-key-query-param-name]
                   [--subscription-required {false, true}]
                   [--tags]

Örnekler

Temel bir API oluşturun.

az apim api update --service-name MyApim -g MyResourceGroup --api-id MyApi --description foo

Gerekli Parametreler

--api-id

Oluşturulacak api'nin benzersiz adı.

--resource-group -g

Kaynak grubunun adı. varsayılan grubu kullanarak 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 dize>.

--api-type

API'nin türü.

kabul edilen değerler: graphql, http, soap, websocket

--description

API'nin açıklaması. HTML biçimlendirme etiketleri içerebilir.

--display-name

API adı. 1 ile 300 karakter uzunluğunda olmalıdır.

--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. Varlık oluştururken gerekli değildir, ancak varlığı güncelleştirirken gereklidir.

--no-wait

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

--path

Gereklidir. Bu API'yi ve API Management hizmet örneği içindeki tüm kaynak yollarını benzersiz olarak tanımlayan göreli URL.

--protocols

Bu API'deki işlemlerin hangi protokollerin çağrılabileceğini açıklar.

kabul edilen değerler: http, https, ws, wss

--remove

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

--service-url

Bu API'yi uygulayan arka uç hizmetinin mutlak URL'si. 2000 karakterden uzun olamaz.

--set

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

--subscription-key-header-name

Abonelik anahtarı üst bilgi adını belirtir.

--subscription-key-query-param-name

Abonelik anahtarı sorgu dizesi parametre adını belirtir.

--subscription-required

Doğruysa, API isteklerde bir abonelik anahtarı gerektirir.

kabul edilen değerler: false, true

--tags

Boşlukla ayrılmış etiketler: key[=value] [key[=value] ...]. Mevcut etiketleri temizlemek için "" kullanı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 api wait

Düzenle

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

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

Örnekler

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

az apim api wait --created --api-id MyApi --name MyApim --resource-group MyResourceGroup

Gerekli Parametreler

--api-id

API düzeltme tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltmenin sonek olarak ;rev=n değeri vardır; burada n, düzeltme numarasıdır.

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