az apic api

Note

This reference is part of the apic-extension extension for the Azure CLI (version 2.57.0 or higher). uzantı, az apic api komutunu ilk kez çalıştırdığınızda otomatik olarak yüklenir. Learn more about extensions.

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.	Extension	GA
az apic api definition	API Center'da API tanımlarını yönetme komutları.	Extension	GA
az apic api definition create	Yeni bir API tanımı oluşturun veya var olan bir API tanımını güncelleştirin.	Extension	GA
az apic api definition delete	Belirtilen API tanımını silin.	Extension	GA
az apic api definition export-specification	API belirtimini dışarı aktarır.	Extension	GA
az apic api definition import-specification	API belirtimini içeri aktarır.	Extension	GA
az apic api definition list	API tanımları koleksiyonunu listeleyin.	Extension	GA
az apic api definition show	API tanımının ayrıntılarını alın.	Extension	GA
az apic api definition update	Mevcut API tanımını güncelleştirin.	Extension	GA
az apic api delete	Belirtilen API'leri silin.	Extension	GA
az apic api deployment	API Center'da API dağıtımlarını yönetme komutları.	Extension	GA
az apic api deployment create	Yeni bir API dağıtımı oluşturun veya mevcut API dağıtımlarını güncelleştirin.	Extension	GA
az apic api deployment delete	API dağıtımlarını silin.	Extension	GA
az apic api deployment list	API dağıtımları koleksiyonunu listeleyin.	Extension	GA
az apic api deployment show	API dağıtımının ayrıntılarını alın.	Extension	GA
az apic api deployment update	Mevcut API dağıtımlarını güncelleştirin.	Extension	GA
az apic api list	API'lerden oluşan bir koleksiyonu listeleyin.	Extension	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.	Extension	Preview
az apic api show	API'nin ayrıntılarını alın.	Extension	GA
az apic api update	Mevcut API'leri güncelleştirin.	Extension	GA
az apic api version	API Center'da API sürümlerini yönetme komutları.	Extension	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.	Extension	GA
az apic api version delete	Belirtilen API sürümünü silin.	Extension	GA
az apic api version list	API sürümlerinin bir koleksiyonunu listeleyin.	Extension	GA
az apic api version show	API sürümünün ayrıntılarını alın.	Extension	GA
az apic api version update	Mevcut API sürümünü güncelleştirin.	Extension	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

Create API

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}'

json dosyasını kullanarak ö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 '@customProperties.json'

Gerekli Parametreler

--api-id

API'nin kimliği.

--resource-group -g

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

--service-name -n

Azure API Center hizmetinin adı.

--title

API title.

Özellik	Değer
Parameter group:	Properties Arguments

--type

API türü.

Özellik	Değer
Parameter group:	Properties Arguments
Kabul edilen değerler:	graphql, grpc, rest, soap, webhook, websocket

İsteğe Bağlı Parametreler

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Özellik	Değer
Parameter group:	Properties Arguments

--custom-properties

API kataloğu varlıkları için tanımlanan özel meta veriler. Kısa söz dizimi, json-file ve yaml-file desteği. Daha fazla göstermek için "??" seçeneğini deneyin.

Özellik	Değer
Parameter group:	Properties Arguments

--description

API'nin açıklaması.

Özellik	Değer
Parameter group:	Properties Arguments

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

Özellik	Değer
Parameter group:	Properties Arguments

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

Özellik	Değer
Parameter group:	Properties Arguments

--summary

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

Özellik	Değer
Parameter group:	Properties Arguments

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.

Özellik	Değer
Default value:	False

--help -h

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

--only-show-errors

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

Özellik	Değer
Default value:	False

--output -o

Output format.

Özellik	Değer
Default value:	json
Kabul edilen değerler:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

Aboneliğin adı veya kimliği. az account set -s NAME_OR_IDkullanarak varsayı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.

Özellik	Değer
Default value:	False

az apic api delete

Belirtilen API'leri silin.

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

Örnekler

Delete API

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

İsteğe Bağlı Parametreler

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-id

API'nin kimliği.

Özellik	Değer
Parameter group:	Resource Id Arguments

--ids

Bir veya daha fazla kaynak kimliği (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' parametrelerini vermelisiniz.

Özellik	Değer
Parameter group:	Resource Id Arguments

--resource-group -g

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

Özellik	Değer
Parameter group:	Resource Id Arguments

--service-name -n

Azure API Center hizmetinin adı.

Özellik	Değer
Parameter group:	Resource Id Arguments

--subscription

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

Özellik	Değer
Parameter group:	Resource Id Arguments

--yes -y

Onay istemde bulunmayın.

Özellik	Değer
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.

Özellik	Değer
Default value:	False

--help -h

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

--only-show-errors

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

Özellik	Değer
Default value:	False

--output -o

Output format.

Özellik	Değer
Default value:	json
Kabul edilen değerler:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Özellik	Değer
Default value:	False

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

List APIs

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ı. az configure --defaults group=<name>kullanarak varsayılan grubu yapılandırabilirsiniz.

--service-name -n

Azure API Center hizmetinin adı.

İsteğe Bağlı Parametreler

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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 bir komutun --next-token bağımsız değişkeninde belirteç değerini sağlayın.

Özellik	Değer
Parameter group:	Pagination Arguments

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

Özellik	Değer
Parameter group:	Pagination Arguments

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.

Özellik	Değer
Default value:	False

--help -h

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

--only-show-errors

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

Özellik	Değer
Default value:	False

--output -o

Output format.

Özellik	Değer
Default value:	json
Kabul edilen değerler:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

Aboneliğin adı veya kimliği. az account set -s NAME_OR_IDkullanarak varsayı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.

Özellik	Değer
Default value:	False

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

Belirtim url'si sağlayarak api'yi kaydedin.

az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.json" --environment-id public
az apic api register -g api-center-test -n contosoeuap --api-location "https://petstore.swagger.io/v2/swagger.yaml" --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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Özellik	Değer
Default value:	False

--help -h

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

--only-show-errors

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

Özellik	Değer
Default value:	False

--output -o

Output format.

Özellik	Değer
Default value:	json
Kabul edilen değerler:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

Aboneliğin adı veya kimliği. az account set -s NAME_OR_IDkullanarak varsayı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.

Özellik	Değer
Default value:	False

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-id

API'nin kimliği.

Özellik	Değer
Parameter group:	Resource Id Arguments

--ids

Bir veya daha fazla kaynak kimliği (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' parametrelerini vermelisiniz.

Özellik	Değer
Parameter group:	Resource Id Arguments

--resource-group -g

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

Özellik	Değer
Parameter group:	Resource Id Arguments

--service-name -n

Azure API Center hizmetinin adı.

Özellik	Değer
Parameter group:	Resource Id Arguments

--subscription

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

Özellik	Değer
Parameter group:	Resource Id Arguments

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.

Özellik	Değer
Default value:	False

--help -h

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

--only-show-errors

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

Özellik	Değer
Default value:	False

--output -o

Output format.

Özellik	Değer
Default value:	json
Kabul edilen değerler:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Özellik	Değer
Default value:	False

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

Update API

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}'

JSON dosyasını kullanarak özel özellikleri güncelleştirme

az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '@customProperities.json'

Tek özel meta verileri güncelleştirme

az apic api update -g contoso-resources -n contoso --api-id echo-api --set customProperties.internal=false

İsteğe Bağlı Parametreler

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

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

Özellik	Değer
Parameter group:	Generic Update Arguments

--api-id

API'nin kimliği.

Özellik	Değer
Parameter group:	Resource Id Arguments

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

Özellik	Değer
Parameter group:	Properties Arguments

--custom-properties

API kataloğu varlıkları için tanımlanan özel meta veriler. Kısa söz dizimi, json-file ve yaml-file desteği. Daha fazla göstermek için "??" seçeneğini deneyin.

Özellik	Değer
Parameter group:	Properties Arguments

--description

API'nin açıklaması.

Özellik	Değer
Parameter group:	Properties Arguments

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

Özellik	Değer
Parameter group:	Properties Arguments

--force-string

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

Özellik	Değer
Parameter group:	Generic Update Arguments
Kabul edilen değerler:	0, 1, f, false, n, no, t, true, y, yes

--ids

Bir veya daha fazla kaynak kimliği (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' parametrelerini vermelisiniz.

Özellik	Değer
Parameter group:	Resource Id Arguments

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

Özellik	Değer
Parameter group:	Properties Arguments

--remove

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

Özellik	Değer
Parameter group:	Generic Update Arguments

--resource-group -g

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

Özellik	Değer
Parameter group:	Resource Id Arguments

--service-name -n

Azure API Center hizmetinin adı.

Özellik	Değer
Parameter group:	Resource Id Arguments

--set

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

Özellik	Değer
Parameter group:	Generic Update Arguments

--subscription

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

Özellik	Değer
Parameter group:	Resource Id Arguments

--summary

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

Özellik	Değer
Parameter group:	Properties Arguments

--title

API title.

Özellik	Değer
Parameter group:	Properties Arguments

--type

API türü.

Özellik	Değer
Parameter group:	Properties Arguments
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.

Özellik	Değer
Default value:	False

--help -h

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

--only-show-errors

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

Özellik	Değer
Default value:	False

--output -o

Output format.

Özellik	Değer
Default value:	json
Kabul edilen değerler:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Özellik	Değer
Default value:	False