az apic api

Başvuru

Not

Bu başvuru, Azure CLI (sürüm 2.57.0 veya üzeri) içinpic-extension uzantısının bir parçasıdır. Uzantı, az apic api komutunu ilk kez çalıştırdığınızda otomatik olarak yüklenir. Uzantılar hakkında daha fazla bilgi edinin.

API Center'da API'leri yönetme komutları.

Komutlar

Name	Description	Tür	Durum
az apic api create	Yeni bir API kaydedin veya var olan bir API'yi güncelleştirin.	Dahili	GA
az apic api definition	API Center'da API tanımlarını yönetme komutları.	Dahili	GA
az apic api definition create	Yeni bir API tanımı oluşturun veya var olan bir API tanımını güncelleştirin.	Dahili	GA
az apic api definition delete	Belirtilen API tanımını silin.	Dahili	GA
az apic api definition export-specification	API belirtimini dışarı aktarır.	Dahili	GA
az apic api definition import-specification	API belirtimini içeri aktarır.	Dahili	GA
az apic api definition list	API tanımları koleksiyonunu listeleyin.	Dahili	GA
az apic api definition show	API tanımının ayrıntılarını alın.	Dahili	GA
az apic api definition update	Mevcut API tanımını güncelleştirin.	Dahili	GA
az apic api delete	Belirtilen API'leri silin.	Dahili	GA
az apic api deployment	API Center'da API dağıtımlarını yönetme komutları.	Dahili	GA
az apic api deployment create	Yeni bir API dağıtımı oluşturun veya mevcut API dağıtımlarını güncelleştirin.	Dahili	GA
az apic api deployment delete	API dağıtımlarını silin.	Dahili	GA
az apic api deployment list	API dağıtımları koleksiyonunu listeleyin.	Dahili	GA
az apic api deployment show	API dağıtımının ayrıntılarını alın.	Dahili	GA
az apic api deployment update	Mevcut API dağıtımlarını güncelleştirin.	Dahili	GA
az apic api list	API'lerden oluşan bir koleksiyonu listeleyin.	Dahili	GA
az apic api register	Belirtim dosyasını kullanarak sürüm, tanım ve ilişkili dağıtımlarla yeni bir API'yi gerçeklik kaynağı olarak kaydeder. Şimdilik yalnızca OpenAPI JSON/YAML biçimini destekliyoruz.	Dahili	Önizle
az apic api show	API'nin ayrıntılarını alın.	Dahili	GA
az apic api update	Mevcut API'leri güncelleştirin.	Dahili	GA
az apic api version	API Center'da API sürümlerini yönetme komutları.	Dahili	GA
az apic api version create	Yeni bir API sürümü oluşturun veya var olan bir API sürümünü güncelleştirin.	Dahili	GA
az apic api version delete	Belirtilen API sürümünü silin.	Dahili	GA
az apic api version list	API sürümlerinin bir koleksiyonunu listeleyin.	Dahili	GA
az apic api version show	API sürümünün ayrıntılarını alın.	Dahili	GA
az apic api version update	Mevcut API sürümünü güncelleştirin.	Dahili	GA

az apic api create

Yeni bir API kaydedin veya var olan bir API'yi güncelleştirin.

az apic api create --api-id
                   --resource-group
                   --service-name
                   --title
                   --type {graphql, grpc, rest, soap, webhook, websocket}
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--license]
                   [--summary]

Örnekler

API oluşturma

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST

Özel özelliklerle API oluşturma

az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '{"public-facing":true}'

Gerekli Parametreler

--api-id

API'nin kimliği.

--resource-group -g

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

--service-name -n

Azure API Center hizmetinin adı.

--title

API başlığı.

--type

API türü.

Kabul edilen değerler: graphql, grpc, rest, soap, webhook, websocket

İsteğe Bağlı Parametreler

--contacts

API için iletişim bilgileri. Kısa söz dizimi, json-file ve yaml-file desteği. Daha fazla göstermek için "??" seçeneğini deneyin.

--custom-properties

API kataloğu varlıkları için tanımlanan özel meta veriler. json-file ve yaml-file desteği.

--description

API'nin açıklaması.

--external-documentation

API için ek, dış belgeler. Kısa söz dizimi, json-file ve yaml-file desteği. Daha fazla göstermek için "??" seçeneğini deneyin.

--license

API'nin lisans bilgileri. Kısa söz dizimi, json-file ve yaml-file desteği. Daha fazla göstermek için "??" seçeneğini deneyin.

--summary

API'nin kısa açıklaması.

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 ve uyarıları gizler.

--output -o

Çıkış biçimi.

Kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayılan aboneliği yapı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 apic api delete

Belirtilen API'leri silin.

az apic api delete [--api-id]
                   [--ids]
                   [--resource-group]
                   [--service-name]
                   [--subscription]
                   [--yes]

Örnekler

API'leri silme

az apic api delete -g contoso-resources -n contoso --api-id echo-api

İsteğe Bağlı Parametreler

--api-id

API'nin kimliği.

--ids

Bir veya daha fazla kaynak kimlikleri (boşlukla ayrılmış). 'Kaynak Kimliği' bağımsız değişkenlerinin tüm bilgilerini içeren eksiksiz bir kaynak kimliği olmalıdır. --ids veya diğer 'Kaynak Kimliği' bağımsız değişkenlerini sağlamanız gerekir.

--resource-group -g

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

--service-name -n

Azure API Center hizmetinin adı.

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayılan aboneliği yapılandırabilirsiniz.

--yes -y

Onay istemde bulunmayın.

Default value: False

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 ve uyarıları gizler.

--output -o

Çıkış biçimi.

Kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayılan aboneliği yapı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 apic api list

API'lerden oluşan bir koleksiyonu listeleyin.

az apic api list --resource-group
                 --service-name
                 [--filter]
                 [--max-items]
                 [--next-token]

Örnekler

API'leri listeleme

az apic api list -g contoso-resources -n contoso

Filtre ile API'leri listeleme

az apic api list -g contoso-resources -n contoso --filter "kind eq 'rest'"

Gerekli Parametreler

--resource-group -g

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

--service-name -n

Azure API Center hizmetinin adı.

İsteğe Bağlı Parametreler

--filter

OData filtre parametresi.

--max-items

Komutun çıkışında döndürülecek toplam öğe sayısı. Kullanılabilir öğelerin toplam sayısı belirtilen değerden fazlaysa, komutun çıkışında bir belirteç sağlanır. Sayfalandırmayı sürdürmek için sonraki komutun bağımsız değişkeninde --next-token belirteç değerini sağlayın.

--next-token

Sayfalandırmanın nereden başlatılacağını belirtmek için belirteç. Bu, daha önce kesilmiş bir yanıttan alınan belirteç değeridir.

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 ve uyarıları gizler.

--output -o

Çıkış biçimi.

Kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayılan aboneliği yapı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 apic api register

Önizleme

Bu komut önizleme aşamasında ve geliştirme aşamasındadır. Başvuru ve destek düzeyleri: https://aka.ms/CLI_refstatus

Belirtim dosyasını kullanarak sürüm, tanım ve ilişkili dağıtımlarla yeni bir API'yi gerçeklik kaynağı olarak kaydeder. Şimdilik yalnızca OpenAPI JSON/YAML biçimini destekliyoruz.

az apic api register --api-location
                     --resource-group
                     --service-name
                     [--environment-id]

Örnekler

Belirtim dosyası sağlayarak api'yi kaydedin.

az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.yml" --environment-id public

Gerekli Parametreler

--api-location -l

Belirtim dosyasının konumu.

--resource-group -g

Kaynak grubu adı.

--service-name -n

APICenter Kataloğu veya Hizmet adı.

İsteğe Bağlı Parametreler

--environment-id

Daha önce oluşturulan ortamın kimliği.

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 ve uyarıları gizler.

--output -o

Çıkış biçimi.

Kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayılan aboneliği yapı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 apic api show

API'nin ayrıntılarını alın.

az apic api show [--api-id]
                 [--ids]
                 [--resource-group]
                 [--service-name]
                 [--subscription]

Örnekler

API ayrıntılarını göster

az apic api show -g contoso-resources -n contoso --api-id echo-api

İsteğe Bağlı Parametreler

--api-id

API'nin kimliği.

--ids

--resource-group -g

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

--service-name -n

Azure API Center hizmetinin adı.

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayılan aboneliği 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österir ve uyarıları gizler.

--output -o

Çıkış biçimi.

Kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayılan aboneliği yapı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 apic api update

Mevcut API'leri güncelleştirin.

az apic api update [--add]
                   [--api-id]
                   [--contacts]
                   [--custom-properties]
                   [--description]
                   [--external-documentation]
                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                   [--ids]
                   [--license]
                   [--remove]
                   [--resource-group]
                   [--service-name]
                   [--set]
                   [--subscription]
                   [--summary]
                   [--title]
                   [--type {graphql, grpc, rest, soap, webhook, websocket}]

Örnekler

API'sini güncelleştirme

az apic api update -g contoso-resources -n contoso --api-id echo-api --summary "Basic REST API service"

Özel özellikleri güncelleştirme

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '{"public-facing":true}'

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

--api-id

API'nin kimliği.

--contacts

API için iletişim bilgileri. Kısa söz dizimi, json-file ve yaml-file desteği. Daha fazla göstermek için "??" seçeneğini deneyin.

--custom-properties

API kataloğu varlıkları için tanımlanan özel meta veriler. json-file ve yaml-file desteği.

--description

API'nin açıklaması.

--external-documentation

API için ek, dış belgeler. Kısa söz dizimi, json-file ve yaml-file desteği. Daha fazla göstermek için "??" seçeneğini deneyin.

--force-string

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

Kabul edilen değerler: 0, 1, f, false, n, no, t, true, y, yes

--ids

--license

API'nin lisans bilgileri. Kısa söz dizimi, json-file ve yaml-file desteği. Daha fazla göstermek için "??" seçeneğini deneyin.

--remove

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

--resource-group -g

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

--service-name -n

Azure API Center hizmetinin adı.

--set

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

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayılan aboneliği yapılandırabilirsiniz.

--summary

API'nin kısa açıklaması.

--title

API başlığı.

--type

API türü.

Kabul edilen değerler: graphql, grpc, rest, soap, webhook, websocket

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 ve uyarıları gizler.

--output -o

Çıkış biçimi.

Kabul edilen değerler: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

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

--subscription

Aboneliğin adı veya kimliği. kullanarak az account set -s NAME_OR_IDvarsayılan aboneliği yapı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.

Aracılığıyla paylaş

az apic api

Komutlar

az apic api create

Örnekler

Gerekli Parametreler

İsteğe Bağlı Parametreler

az apic api delete

Örnekler

İsteğe Bağlı Parametreler

az apic api list

Örnekler

Gerekli Parametreler

İsteğe Bağlı Parametreler

az apic api register

Örnekler

Gerekli Parametreler

İsteğe Bağlı Parametreler

az apic api show

Örnekler

İsteğe Bağlı Parametreler

az apic api update

Örnekler

İsteğe Bağlı Parametreler

Ek kaynaklar