az apic

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

Azure API Center hizmetlerini yönetme.

Komutlar

Name Description Tür Durum
az apic api

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

Dahili GA
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 create

Azure API Center hizmetinin bir örneğini oluşturur veya mevcut bir örneğini güncelleştirir.

Dahili GA
az apic delete

Azure API Center hizmetinin bir örneğini siler.

Dahili GA
az apic environment

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

Dahili GA
az apic environment create

Yeni bir ortam oluşturun veya var olan bir ortamı güncelleştirin.

Dahili GA
az apic environment delete

Ortamı silin.

Dahili GA
az apic environment list

Ortam koleksiyonunu listeleyin.

Dahili GA
az apic environment show

Ortamın ayrıntılarını alın.

Dahili GA
az apic environment update

Mevcut ortamı güncelleştirin.

Dahili GA
az apic import-from-apim

Azure API Management hizmet örneğinden API'leri içeri aktarır.

Dahili GA
az apic list

Azure aboneliği içindeki Azure API Center hizmetlerini listeler.

Dahili GA
az apic metadata

API Center'da meta veri şemalarını yönetme komutları.

Dahili GA
az apic metadata create

Yeni bir meta veri şeması oluşturun veya var olan bir meta veri şemasını güncelleştirin.

Dahili GA
az apic metadata delete

Belirtilen meta veri şemasını silin.

Dahili GA
az apic metadata export

Meta veri şemasını dışarı aktarır.

Dahili GA
az apic metadata list

Meta veri şemaları koleksiyonunu listeleyin.

Dahili GA
az apic metadata show

Meta veri şemasının ayrıntılarını alın.

Dahili GA
az apic metadata update

Mevcut meta veri şemasını güncelleştirin.

Dahili GA
az apic show

Azure API Center hizmet örneğinin ayrıntılarını gösterin.

Dahili GA
az apic update

Azure API Center hizmetinin bir örneğini güncelleştirme.

Dahili GA

az apic create

Azure API Center hizmetinin bir örneğini oluşturur veya mevcut bir örneğini güncelleştirir.

az apic create --name
               --resource-group
               [--identity]
               [--location]
               [--tags]

Örnekler

Hizmet oluşturma Örneği 1

az apic create -g contoso-resources -n contoso -l eastus

Hizmet Oluşturma Örneği 2

az apic create --resource-group contoso-resources --name contoso --location eastus

Gerekli Parametreler

--name -n

API Center hizmetinin adı.

--resource-group -g

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

İsteğe Bağlı Parametreler

--identity

Bu kaynağa atanan yönetilen hizmet kimlikleri. Kısa söz dizimi, json-file ve yaml-file desteği. Daha fazla göstermek için "??" seçeneğini deneyin.

--location -l

Kaynağın bulunduğu coğrafi konum Belirtilmediğinde kaynak grubunun konumu kullanılır.

--tags

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

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 delete

Azure API Center hizmetinin bir örneğini siler.

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

Örnekler

Hizmeti sil

az apic delete -n contoso -g contoso-resources

İsteğe Bağlı Parametreler

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

--name -n

API Center hizmetinin adı.

--resource-group -g

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

--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 import-from-apim

Azure API Management hizmet örneğinden API'leri içeri aktarır.

az apic import-from-apim --apim-apis
                         --apim-name
                         [--apim-resource-group]
                         [--apim-subscription]
                         [--ids]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--resource-group]
                         [--service-name]
                         [--subscription]

Örnekler

Aynı kaynak grubundaki APIM'den tüm API'leri içeri aktarma

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis *

Seçili API'leri aynı kaynak grubundaki APIM'den içeri aktarma

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis [echo,foo]

APIM'deki tüm API'leri başka bir abonelikte ve kaynak grubunda içeri aktarma

az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-subscription 00000000-0000-0000-0000-000000000000 --apim-resource-group apim-rg --apim-name contoso-apim --apim-apis *

Gerekli Parametreler

--apim-apis

İçeri aktarılacak API'ler. Kısa söz dizimi, json-file ve yaml-file desteği. Daha fazla göstermek için "??" seçeneğini deneyin.

--apim-name

Kaynak APIM örneğinin adı.

İsteğe Bağlı Parametreler

--apim-resource-group

Kaynak APIM örneğinin kaynak grubu.

--apim-subscription

Kaynak APIM örneğinin abonelik 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.

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

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 list

Azure aboneliği içindeki Azure API Center hizmetlerini listeler.

Bir abonelik altındaki tüm kaynakları listelemenin çalışmamasıyla ilgili bilinen bir sorun vardır. Lütfen kaynakları kaynak grubuna göre listeleyin.

az apic list [--max-items]
             [--next-token]
             [--resource-group]

Örnekler

Kaynak grubundaki hizmetleri listeleme

az apic list -g contoso-resources

İsteğe Bağlı Parametreler

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

--resource-group -g

Kaynak grubunun adı. kullanarak varsayılan grubu az configure --defaults group=<name>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 show

Azure API Center hizmet örneğinin ayrıntılarını gösterin.

az apic show [--ids]
             [--name]
             [--resource-group]
             [--subscription]

Örnekler

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

az apic show -g contoso-resources -n contoso

İsteğe Bağlı Parametreler

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

--name -n

API Center hizmetinin adı.

--resource-group -g

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

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

Azure API Center hizmetinin bir örneğini güncelleştirme.

az apic update [--add]
               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
               [--identity]
               [--ids]
               [--name]
               [--remove]
               [--resource-group]
               [--set]
               [--subscription]
               [--tags]

Örnekler

Hizmet ayrıntılarını güncelleştirme

az apic update -g contoso-resources -n contoso

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

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

Bu kaynağa atanan yönetilen hizmet kimlikleri. Kısa söz dizimi, json-file ve yaml-file desteği. Daha fazla göstermek için "??" seçeneğini deneyin.

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

--name -n

API Center hizmetinin adı.

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

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

--tags

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

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.