Aracılığıyla paylaş

az apic metadata

Note

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

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

Komutlar

Name Description Tür Durum
az apic metadata create

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

 Extension GA
az apic metadata delete

Belirtilen meta veri şemasını silin.

 Extension GA
az apic metadata export

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

 Extension GA
az apic metadata list

Meta veri şemaları koleksiyonunu listeleyin.

 Extension GA
az apic metadata show

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

 Extension GA
az apic metadata update

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

 Extension GA

az apic metadata create

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

az apic metadata create --assignments
                        --metadata-name
                        --resource-group
                        --schema
                        --service-name

Örnekler

Meta veri oluşturma örneği 1

az apic metadata create --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '{"type":"string", "title":"First name", "pattern": "^[a-zA-Z0-9]+$"}' --assignments '[{entity:api,required:true,deprecated:false}]'

Meta veri oluşturma örneği 2

az apic metadata create --resource-group api-center-test --service-name contoso  --metadata-name testregion --schema '{"type":"string","title":"testregion","oneOf":[{"const":"Region1","description":""},{"const":"Region2","description":""},{"const":"Region3","description":""}]}' --assignments '[{entity:api,required:true,deprecated:false},{entity:environment,required:true,deprecated:false}]'

JSON dosya şemasını ve atamalarını kullanarak meta veri oluşturma örneği

az apic metadata create --resource-group api-center-test --service-name contoso --metadata-name "test" --schema '@schema.json' --assignments '@assignments.json'

Gerekli Parametreler

--assignments

"[{entity:api,required:true,deprecated:false}]" gibi özel meta veriler için atama kapsamını tanımlar. Kullanılabilir varlık değerleri şunlardır: api, dağıtım, ortam. 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
Parametre grubu: Properties Arguments
--metadata-name

Meta veri şemasının adı.

--resource-group -g

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

--schema

Türü tanımlayan JSON şeması.

Özellik Değer
Parametre grubu: Properties Arguments
--service-name -n

Azure API Center hizmetinin adı.

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

Çıkış biçimi.

Ö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 metadata delete

Belirtilen meta veri şemasını silin.

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

Örnekler

Meta Veri Şemasını Sil

az apic metadata delete --resource-group api-center-test --service-name contoso --metadata-name "test1"

Şemayı sil

az apic metadata delete -g api-center-test -n contosoeuap --metadata-name "approver"

İsteğe Bağlı Parametreler

Aşağıdaki parametreler isteğe bağlıdır, ancak bağlama bağlı olarak komutun başarıyla yürütülmesi için bir veya daha fazla parametre gerekli olabilir.

--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
Parametre grubu: Resource Id Arguments
--metadata-name

Meta veri şemasının adı.

Özellik Değer
Parametre grubu: Resource Id Arguments
--resource-group -g

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

Özellik Değer
Parametre grubu: Resource Id Arguments
--service-name -n

Azure API Center hizmetinin adı.

Özellik Değer
Parametre grubu: 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
Parametre grubu: 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

Çıkış biçimi.

Ö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 metadata export

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

az apic metadata export --assignments {api, deployment, environment}
                        --file-name
                        [--custom-metadata-only {0, 1, f, false, n, no, t, true, y, yes}]
                        [--ids]
                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                        [--resource-group]
                        [--service-name]
                        [--subscription]

Örnekler

Api'ye atanan Meta Veri Şemasını Dışarı Aktarma

az apic metadata export -g api-center-test -n contosoeuap --assignments api --file-name filename.json

Dağıtıma atanan Meta Veri Şemasını Dışarı Aktarma

az apic metadata export -g api-center-test -n contosoeuap --assignments deployment --file-name filename.json

Ortama atanan Meta Veri Şemasını Dışarı Aktar

az apic metadata export -g api-center-test -n contosoeuap --assignments environment --file-name filename.json

Yalnızca Özel Meta Veri Şemasını Dışarı Aktar

az apic metadata export -g api-center-test -n contosoeuap --assignments api --file-name filename.json --custom-metadata-only

Gerekli Parametreler

--assignments

Meta veri şemasının istendi olduğu bir varlık.

Özellik Değer
Parametre grubu: Payload Arguments
Kabul edilen değerler: api, deployment, environment
--file-name

Meta veri şemasının dışarı aktarıldığı dosyanın adı.

İsteğe Bağlı Parametreler

Aşağıdaki parametreler isteğe bağlıdır, ancak bağlama bağlı olarak komutun başarıyla yürütülmesi için bir veya daha fazla parametre gerekli olabilir.

--custom-metadata-only

Yalnızca özel meta verileri dışarı aktarın.

Özellik Değer
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
Parametre grubu: Resource Id Arguments
--no-wait

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

Özellik Değer
Kabul edilen değerler: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

Özellik Değer
Parametre grubu: Resource Id Arguments
--service-name -n

API Center hizmetinin adı.

Özellik Değer
Parametre grubu: 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
Parametre grubu: 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

Çıkış biçimi.

Ö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 metadata list

Meta veri şemaları koleksiyonunu listeleyin.

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

Örnekler

Şemaları listeleme

az apic metadata list -g api-center-test -n contosoeuap

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

Aşağıdaki parametreler isteğe bağlıdır, ancak bağlama bağlı olarak komutun başarıyla yürütülmesi için bir veya daha fazla parametre gerekli olabilir.

--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
Parametre grubu: 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
Parametre grubu: 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

Çıkış biçimi.

Ö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 metadata show

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

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

Örnekler

Şema ayrıntılarını göster 1

az apic metadata show -g api-center-test -n contosoeuap --metadata-name approver

Şema ayrıntılarını göster 2

az apic metadata show --resource-group api-center-test --service-name contoso --metadata-name "testchoices"

İsteğe Bağlı Parametreler

Aşağıdaki parametreler isteğe bağlıdır, ancak bağlama bağlı olarak komutun başarıyla yürütülmesi için bir veya daha fazla parametre gerekli olabilir.

--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
Parametre grubu: Resource Id Arguments
--metadata-name

Meta veri şemasının adı.

Özellik Değer
Parametre grubu: Resource Id Arguments
--resource-group -g

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

Özellik Değer
Parametre grubu: Resource Id Arguments
--service-name -n

Azure API Center hizmetinin adı.

Özellik Değer
Parametre grubu: 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
Parametre grubu: 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

Çıkış biçimi.

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

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

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

Örnekler

Şemayı güncelleştirme

az apic metadata update --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '{"type":"string", "title":"Last name", "pattern": "^[a-zA-Z0-9]+$"}'

Şema json dosyasını kullanarak şemayı güncelleştirme

az apic metadata update --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '@schema.json'

İsteğe Bağlı Parametreler

Aşağıdaki parametreler isteğe bağlıdır, ancak bağlama bağlı olarak komutun başarıyla yürütülmesi için bir veya daha fazla parametre gerekli olabilir.

--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
Parametre grubu: Generic Update Arguments
--assignments

"[{entity:api,required:true,deprecated:false}]" gibi özel meta veriler için atama kapsamını tanımlar. Kullanılabilir varlık değerleri şunlardır: api, dağıtım, ortam. 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
Parametre grubu: 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
Parametre grubu: 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
Parametre grubu: Resource Id Arguments
--metadata-name

Meta veri şemasının adı.

Özellik Değer
Parametre grubu: Resource Id Arguments
--remove

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

Özellik Değer
Parametre grubu: Generic Update Arguments
--resource-group -g

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

Özellik Değer
Parametre grubu: Resource Id Arguments
--schema

Türü tanımlayan YAML şeması.

Özellik Değer
Parametre grubu: Properties Arguments
--service-name -n

Azure API Center hizmetinin adı.

Özellik Değer
Parametre grubu: Resource Id Arguments
--set

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

Özellik Değer
Parametre grubu: 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
Parametre grubu: 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

Çıkış biçimi.

Ö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