az apim api
Azure API Management API'lerini yönetme.
Komutlar
Name | Description | Tür | Durum |
---|---|---|---|
az apim api create |
API Management API'si oluşturma. |
Temel | GA |
az apim api delete |
API Management API'lerini silme. |
Temel | GA |
az apim api export |
API Management API'lerini dışarı aktarma. |
Temel | GA |
az apim api import |
API Management API'lerini içeri aktarma. |
Temel | GA |
az apim api list |
API Management API'lerini listeleyin. |
Temel | GA |
az apim api operation |
Azure API Management API İşlemlerini yönetme. |
Temel | GA |
az apim api operation create |
API'de yeni bir işlem oluşturur. |
Temel | GA |
az apim api operation delete |
API'de belirtilen işlemi siler. |
Temel | GA |
az apim api operation list |
Belirtilen API için işlem koleksiyonunu listeleyin. |
Temel | GA |
az apim api operation show |
Tanımlayıcısı tarafından belirtilen API İşleminin ayrıntılarını alır. |
Temel | GA |
az apim api operation update |
api'de tanımlayıcısı tarafından belirtilen işlemin ayrıntılarını Güncelleştirmeler. |
Temel | GA |
az apim api release |
Azure API Management API Yayınını yönetme. |
Temel | GA |
az apim api release create |
API için yeni bir Yayın oluşturur. |
Temel | GA |
az apim api release delete |
API'de belirtilen sürümü siler. |
Temel | GA |
az apim api release list |
BIR API'nin tüm sürümlerini listeler. |
Temel | GA |
az apim api release show |
API sürümünün ayrıntılarını döndürür. |
Temel | GA |
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. |
Temel | GA |
az apim api revision |
Azure API Management API Düzeltmesi'nin yönetilmesi. |
Temel | GA |
az apim api revision create |
API düzeltmesi oluşturma. |
Temel | GA |
az apim api revision list |
API'nin tüm düzeltmelerini listeler. |
Temel | GA |
az apim api schema |
Azure API Management API Şemalarını yönetme. |
Temel | GA |
az apim api schema create |
API Management API Şeması oluşturma. |
Temel | GA |
az apim api schema delete |
API Management API Şemasını silme. |
Temel | GA |
az apim api schema get-etag |
API Management API şemasının etag'ini alın. |
Temel | GA |
az apim api schema list |
API Management API şemalarını listeleyin. |
Temel | GA |
az apim api schema show |
API Management API Şemasının ayrıntılarını gösterir. |
Temel | GA |
az apim api schema wait |
BIR apim API şeması koşulu karşılanıncaya kadar CLI'yi bekleme durumuna yerleştirin. |
Temel | GA |
az apim api show |
API Management API'sinin ayrıntılarını gösterir. |
Temel | GA |
az apim api update |
API Management API'sini güncelleştirme. |
Temel | GA |
az apim api versionset |
Azure API Management API Sürüm Kümesini yönetme. |
Temel | GA |
az apim api versionset create |
Api Sürüm Kümesi oluşturur. |
Temel | GA |
az apim api versionset delete |
Belirli Api Sürüm Kümesini siler. |
Temel | GA |
az apim api versionset list |
Belirtilen hizmet örneğinde API Sürüm Kümeleri koleksiyonunu listeler. |
Temel | GA |
az apim api versionset show |
Tanımlayıcısı tarafından belirtilen Api Sürüm Kümesinin ayrıntılarını alır. |
Temel | GA |
az apim api versionset update |
Tanımlayıcısı tarafından belirtilen Api VersionSet'in ayrıntılarını Güncelleştirmeler. |
Temel | GA |
az apim api wait |
BIR apim API'sinin koşulu karşılanıncaya kadar CLI'yi bekleme durumuna yerleştirin. |
Temel | GA |
az apim api create
API Management API'si oluşturma.
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
Oluşturulacak api'nin benzersiz adı.
API düzeltme tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.
Oluşturulacak API'nin görünen adı.
API'nin yolu.
Kaynak grubunun adı. kullanarak varsayılan grubu az configure --defaults group=<name>
yapılandırabilirsiniz.
API Management hizmet örneğinin adı.
İsteğe Bağlı Parametreler
API'nin türü.
OAuth işlemleri kapsamını belirtir.
OAuth yetkilendirme sunucusu kimliğini belirtir.
Taşıyıcı belirteci için gönderme yöntemlerini belirtir.
API'nin açıklaması. HTML biçimlendirme etiketleri içerebilir.
Uzun süre çalışan işlemin bitmesini beklemeyin.
Kimlik doğrulama ayarında openid değerini belirtir.
Bu API'deki işlemlerin çağrılabileceği protokolleri açıklar.
Bu API'yi uygulayan arka uç hizmetinin mutlak URL'si. 2000 karakterden uzun olamaz.
Abonelik anahtarı üst bilgi adını belirtir.
Abonelik anahtarı sorgu dizesi parametre adını belirtir.
Bu API'ye çağrı sırasında abonelik anahtarının gerekli olup olmadığını 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.
True ise, API isteklerde bir abonelik anahtarı gerektirir.
Global Parametreler
Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.
Bu yardım iletisini göster ve çık.
Yalnızca hataları gösterir ve uyarıları gizler.
Çıkış biçimi.
JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz http://jmespath.org/ .
Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_ID
varsayılan aboneliği yapılandırabilirsiniz.
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
API Management API'lerini silme.
az apim api delete --api-id
--resource-group
--service-name
[--delete-revisions]
[--if-match]
[--no-wait]
[--yes]
Gerekli Parametreler
API tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.
Kaynak grubunun adı. kullanarak varsayılan grubu az configure --defaults group=<name>
yapılandırabilirsiniz.
API Management hizmet örneğinin adı.
İsteğe Bağlı Parametreler
Api'nin tüm düzeltmelerini silin.
Varlığın ETag'i.
Uzun süre çalışan işlemin bitmesini beklemeyin.
Onay istemde bulunmayın.
Global Parametreler
Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.
Bu yardım iletisini göster ve çık.
Yalnızca hataları gösterir ve uyarıları gizler.
Çıkış biçimi.
JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz http://jmespath.org/ .
Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_ID
varsayılan aboneliği yapılandırabilirsiniz.
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 export
API Management API'lerini dışarı aktarma.
az apim api export --api-id
--ef {OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl}
--resource-group
--service-name
[--file-path]
Örnekler
API Management API'sini bir dosyaya aktarın veya dışarı aktarma bağlantısını içeren bir yanıt döndürür.
az apim api export -g MyResourceGroup --service-name MyApim --api-id MyApi --export-format OpenApiJson --file-path path
Gerekli Parametreler
API tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır. Kayıt defteri deseni: ^[^*#&+:<>?] +$.
Dışarı aktarma API'sinin biçimini belirtin.
Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
Api management hizmet örneğinin adı.
İsteğe Bağlı Parametreler
API'yi dışarı aktarmak için belirtilen dosya yolu.
Global Parametreler
Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.
Bu yardım iletisini göster ve çık.
Yalnızca hataları gösterir ve uyarıları gizler.
Çıkış biçimi.
JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz http://jmespath.org/ .
Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_ID
varsayılan aboneliği yapılandırabilirsiniz.
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
API Management API'lerini içeri aktarma.
az apim api import --path
--resource-group
--service-name
--specification-format {GraphQL, 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'sini 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
Gerekli. Bu API'yi ve API Management hizmet örneği içindeki tüm kaynak yollarını benzersiz olarak tanımlayan göreli URL.
Kaynak grubunun adı. kullanarak varsayılan grubu az configure --defaults group=<name>
yapılandırabilirsiniz.
Api management hizmet örneğinin adı.
İçeri aktarılan API'nin biçimini belirtin.
İsteğe Bağlı Parametreler
API tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.
Api'nin Düzeltmesini açıklar. Değer sağlanmazsa, varsayılan düzeltme 1 oluşturulur.
API'nin türü.
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 ile kullanılacak Sürüm Kümesini açıklar.
API'nin açıklaması. HTML biçimlendirme etiketleri içerebilir.
Bu API'nin görünen adı.
Uzun süre çalışan işlemin bitmesini beklemeyin.
Bu API'deki işlemlerin çağrılabileceği protokolleri (bir veya daha fazla) açıklar.
Bu API'yi uygulayan arka uç hizmetinin mutlak URL'si. 2000 karakterden uzun olamaz.
Dosya biçimi WSDL olduğunda API türü.
API'yi içeri aktarmak için belirtilen dosya yolu.
API'yi içeri aktarmak için belirtilen URL.
Abonelik anahtarı üst bilgi adını belirtir.
Abonelik anahtarı sorgu dizesi parametre adını belirtir.
True ise, API isteklerde bir abonelik anahtarı gerektirir.
İçeri aktarılacak WSDL Uç Noktasının (bağlantı noktası) yerel adı.
İçeri aktarılacak WSDL Hizmetinin yerel adı.
Global Parametreler
Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.
Bu yardım iletisini göster ve çık.
Yalnızca hataları gösterir ve uyarıları gizler.
Çıkış biçimi.
JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz http://jmespath.org/ .
Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_ID
varsayılan aboneliği yapılandırabilirsiniz.
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
API Management API'lerini listeleyin.
az apim api list --resource-group
--service-name
[--filter-display-name]
[--skip]
[--top]
Gerekli Parametreler
Kaynak grubunun adı. kullanarak varsayılan grubu az configure --defaults group=<name>
yapılandırabilirsiniz.
API Management hizmet örneğinin adı.
İsteğe Bağlı Parametreler
API'leri displayName'e göre filtreleyin.
Atlana kayıt sayısı.
Döndürülecek kayıt sayısı.
Global Parametreler
Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.
Bu yardım iletisini göster ve çık.
Yalnızca hataları gösterir ve uyarıları gizler.
Çıkış biçimi.
JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz http://jmespath.org/ .
Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_ID
varsayılan aboneliği yapılandırabilirsiniz.
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
API Management API'sinin ayrıntılarını gösterir.
az apim api show --api-id
--resource-group
--service-name
Gerekli Parametreler
API tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.
Kaynak grubunun adı. kullanarak varsayılan grubu az configure --defaults group=<name>
yapılandırabilirsiniz.
API Management hizmet örneğinin adı.
Global Parametreler
Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.
Bu yardım iletisini göster ve çık.
Yalnızca hataları gösterir ve uyarıları gizler.
Çıkış biçimi.
JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz http://jmespath.org/ .
Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_ID
varsayılan aboneliği yapılandırabilirsiniz.
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
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
Oluşturulacak api'nin benzersiz adı.
API düzeltme tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.
Kaynak grubunun adı. kullanarak varsayılan grubu az configure --defaults group=<name>
yapılandırabilirsiniz.
API Management hizmet örneğinin adı.
İsteğe Bağlı Parametreler
Bir yol ve anahtar değer çiftleri belirterek nesne listesine nesne ekleyin. Örnek: --add property.listProperty <key=value, string or JSON string>
.
API'nin türü.
API'nin açıklaması. HTML biçimlendirme etiketleri içerebilir.
API adı. 1 ile 300 karakter uzunluğunda olmalıdır.
'set' veya 'add' kullanırken, JSON'a dönüştürmeye çalışmak yerine dize değişmez değerlerini koruyun.
Varlığın ETag'i. Varlık oluştururken gerekli değildir, ancak varlığı güncelleştirirken gereklidir. Varsayılan değer Yok'tır.
Uzun süre çalışan işlemin bitmesini beklemeyin.
Gerekli. Bu API'yi ve API Management hizmet örneği içindeki tüm kaynak yollarını benzersiz olarak tanımlayan göreli URL.
Bu API'deki işlemlerin çağrılabileceği protokolleri açıklar.
Bir özelliği veya öğeyi listeden kaldırın. Örnek: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Bu API'yi uygulayan arka uç hizmetinin mutlak URL'si. 2000 karakterden uzun olamaz.
Ayarlanacağı özellik yolunu ve değerini belirterek nesneyi güncelleştirin. Örnek: --set property1.property2=<value>
.
Abonelik anahtarı üst bilgi adını belirtir.
Abonelik anahtarı sorgu dizesi parametre adını belirtir.
True ise, API isteklerde bir abonelik anahtarı gerektirir.
Boşlukla ayrılmış etiketler: key[=value] [key[=value] ...]. Mevcut etiketleri temizlemek için "" kullanın.
Global Parametreler
Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.
Bu yardım iletisini göster ve çık.
Yalnızca hataları gösterir ve uyarıları gizler.
Çıkış biçimi.
JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz http://jmespath.org/ .
Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_ID
varsayılan aboneliği yapılandırabilirsiniz.
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
BIR 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
BIR 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 düzeltme tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır. Gerekli.
Api management hizmet örneğinin adı.
Kaynak grubunun adı. kullanarak varsayılan grubu az configure --defaults group=<name>
yapılandırabilirsiniz.
İsteğe Bağlı Parametreler
'ProvisioningState' ile 'Succeeded' konumunda oluşturulana kadar bekleyin.
Koşul özel bir JMESPath sorgusunu karşılayana kadar bekleyin. Örneğin provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Silinene kadar bekleyin.
Kaynak var olana kadar bekleyin.
Saniye cinsinden yoklama aralığı.
Saniye cinsinden en fazla bekleme.
'Başarılı' konumunda provisioningState ile güncelleştirilene kadar bekleyin.
Global Parametreler
Tüm hata ayıklama günlüklerini göstermek için günlük ayrıntı düzeyini artırın.
Bu yardım iletisini göster ve çık.
Yalnızca hataları gösterir ve uyarıları gizler.
Çıkış biçimi.
JMESPath sorgu dizesi. Daha fazla bilgi ve örnek için bkz http://jmespath.org/ .
Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_ID
varsayılan aboneliği yapılandırabilirsiniz.
Günlük ayrıntı düzeyini artırın. Tam hata ayıklama günlükleri için --debug komutunu kullanın.