az apic api definition

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 definition komutunu ilk kez çalıştırdığınızda otomatik olarak yüklenir. Uzantılar hakkında daha fazla bilgi edinin.

API Center'da API tanımlarını yönetme komutları.

Komutlar

Name	Description	Tür	Durum
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 definition create

Yeni bir API tanımı oluşturun veya var olan bir API tanımını güncelleştirin.

az apic api definition create --api-id
                              --definition-id
                              --resource-group
                              --service-name
                              --title
                              --version-id
                              [--description]

Örnekler

API tanımı oluşturma

az apic api definition create -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"

Gerekli Parametreler

--api-id

API'nin kimliği.

--definition-id

API tanımının 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 sürümü.

--version-id

API sürümünün kimliği.

İsteğe Bağlı Parametreler

--description

API tanımı 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 definition delete

Belirtilen API tanımını silin.

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

Örnekler

API tanımını silme

az apic api definition delete -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"

İsteğe Bağlı Parametreler

--api-id

API'nin kimliği.

--definition-id

API tanımının 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.

--version-id

API sürümünün kimliği.

--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 definition export-specification

API belirtimini dışarı aktarır.

az apic api definition export-specification --file-name
                                            [--api-id]
                                            [--definition-id]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--service-name]
                                            [--subscription]
                                            [--version-id]

Örnekler

Dışarı Aktarma Belirtimi

az apic api definition export-specification -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id default --file-name filename.json

Gerekli Parametreler

--file-name

Belirtimin dışarı aktarıldığı dosyanın adı.

İsteğe Bağlı Parametreler

--api-id

API'nin kimliği.

--definition-id

API tanımının kimliği.

--ids

--no-wait

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

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

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

--version-id

API sürümünü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 definition import-specification

API belirtimini içeri aktarır.

az apic api definition import-specification --format {inline, link}
                                            --specification
                                            --value
                                            [--api-id]
                                            [--definition-id]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--service-name]
                                            [--subscription]
                                            [--version-id]

Örnekler

İçeri aktarma belirtimi örneği 1

az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-api-2 --version-id 2023-08-01 --definition-id openapi3 --format "inline" --value '{"openapi":"3.0.1","info":{"title":"httpbin.org","description":"API Management facade for a very handy and free online HTTP tool.","version":"1.0"}}' --specification '{"name":"openapi","version":"3.0.0"}'

İçeri aktarma belirtimi örneği 2

az apic api definition import-specification -g api-center-test -n contoso --api-id echo-api --version-id 2023-11-01 --definition-id openapi --format "link" --value 'https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json' --specification '{"name":"openapi","version":"3.0.0"}'

Gerekli Parametreler

--format

API belirtim kaynağının biçimi.

Kabul edilen değerler: inline, link

--specification

API belirtimi ayrıntıları. Kısa söz dizimi, json-file ve yaml-file desteği. Daha fazla göstermek için "??" seçeneğini deneyin.

--value

API belirtim kaynağının değeri.

İsteğe Bağlı Parametreler

--api-id

API'nin kimliği.

--definition-id

API tanımının kimliği.

--ids

--no-wait

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

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

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

--version-id

API sürümünü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 definition list

API tanımları koleksiyonunu listeleyin.

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

Örnekler

API tanımlarını listeleme

az apic api definition list -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01

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

--version-id

API sürümünün kimliği.

İ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 definition show

API tanımının ayrıntılarını alın.

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

Örnekler

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

az apic api definition show -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"

İsteğe Bağlı Parametreler

--api-id

API'nin kimliği.

--definition-id

API tanımının 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.

--version-id

API sürümünü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 definition update

Mevcut API tanımını güncelleştirin.

az apic api definition update [--add]
                              [--api-id]
                              [--definition-id]
                              [--description]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--remove]
                              [--resource-group]
                              [--service-name]
                              [--set]
                              [--subscription]
                              [--title]
                              [--version-id]

Örnekler

API tanımını güncelleştirme

az apic api definition update -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"

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

--definition-id

API tanımının kimliği.

--description

API tanımı açıklaması.

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

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

--title

API sürüm başlığı.

--version-id

API sürümünü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.

Aracılığıyla paylaş

az apic api definition

Komutlar

az apic api definition create

Örnekler

Gerekli Parametreler

İsteğe Bağlı Parametreler

az apic api definition delete

Örnekler

İsteğe Bağlı Parametreler

az apic api definition export-specification

Örnekler

Gerekli Parametreler

İsteğe Bağlı Parametreler

az apic api definition import-specification

Örnekler

Gerekli Parametreler

İsteğe Bağlı Parametreler

az apic api definition list

Örnekler

Gerekli Parametreler

İsteğe Bağlı Parametreler

az apic api definition show

Örnekler

İsteğe Bağlı Parametreler

az apic api definition update

Örnekler

İsteğe Bağlı Parametreler

Ek kaynaklar