Aracılığıyla paylaş

az apim api schema

  • Başvuru

Azure API Management API Şemalarını yönetme.

Komutlar

Name Description Tür Durum
az apim api schema create

API Management API Şeması oluşturma.

 Temel GA
az apim api schema delete

API Management API Şemasını silme.

 Temel GA
az apim api schema get-etag

API Management API şemasının etag'ini alın.

 Temel GA
az apim api schema list

API Management API şemalarını listeleyin.

 Temel GA
az apim api schema show

API Management API Şemasının ayrıntılarını gösterir.

 Temel GA
az apim api schema wait

BIR apim API şeması koşulu karşılanıncaya kadar CLI'yi bekleme durumuna yerleştirin.

 Temel GA

az apim api schema create

Düzenle

API Management API Şeması oluşturma.

az apim api schema create --api-id
                          --resource-group
                          --schema-id
                          --schema-type
                          --service-name
                          [--no-wait]
                          [--resource-type]
                          [--schema-content]
                          [--schema-name]
                          [--schema-path]

Örnekler

API Şeması oluşturma.

az apim api schema create --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId --schema-type schemaType --schema-path schemaFilePath

Gerekli Parametreler

--api-id

Şemasının oluşturulması gereken api'nin benzersiz adı.

API düzeltme tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.

--resource-group -g

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

--schema-id

Oluşturulacak api şemasının benzersiz adı.

Şema tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.

--schema-type

Şema türü (örn. application/json, application/vnd.ms-azure-apim.graphql.schema).

RFC 2616'da tanımlandığı gibi İçerik Türü üst bilgisinde kullanılan geçerli bir medya türü olmalıdır. Şema belgesinin medya türü.

--service-name -n

API Management hizmet örneğinin adı.

İsteğe Bağlı Parametreler

--no-wait

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

Default value: False
--resource-type

Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft. Depolama/storageAccounts" yazın.

--schema-content

Json, Şemayı temsil eden belgeyi tanımlayan dizeden kaçtı.

--schema-path veya --schema-content her ikisini birden belirtmeyin.

--schema-name

Şema kaynağının adı.

--schema-path

API'nin şemasını içeri aktarmak için belirtilen dosya yolu.

--schema-path veya --schema-content her ikisini birden belirtmeyin.

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 apim api schema delete

Düzenle

API Management API Şemasını silme.

az apim api schema delete --api-id
                          --resource-group
                          --schema-id
                          --service-name
                          [--if-match]
                          [--no-wait]
                          [--yes]

Örnekler

API Şemasını silin.

az apim api schema delete --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

Gerekli Parametreler

--api-id

API tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.

--resource-group -g

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

--schema-id

Şema tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.

--service-name -n

API Management hizmet örneğinin adı.

İsteğe Bağlı Parametreler

--if-match

Varlığın ETag'i.

--no-wait

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

Default value: False
--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 apim api schema get-etag

Düzenle

API Management API şemasının etag'ini alın.

az apim api schema get-etag --api-id
                            --resource-group
                            --schema-id
                            --service-name

Örnekler

bir şema varlık etiketi alın.

az apim api schema get-etag --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

Gerekli Parametreler

--api-id

API tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.

--resource-group -g

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

--schema-id

Şema tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.

--service-name -n

API Management hizmet örneğinin 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.

--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 apim api schema list

Düzenle

API Management API şemalarını listeleyin.

az apim api schema list --api-id
                        --resource-group
                        --service-name
                        [--filter-display-name]
                        [--skip]
                        [--top]

Örnekler

Api kimliğiyle ilişkili şemaların listesini alın.

az apim api schema list --service-name MyApim -g MyResourceGroup --api-id MyApi

Gerekli Parametreler

--api-id

API tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.

--resource-group -g

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

--service-name -n

API Management hizmet örneğinin adı.

İsteğe Bağlı Parametreler

--filter-display-name

API'leri displayName'e göre filtreleyin.

--skip

Atlana kayıt sayısı.

--top

Döndürülecek kayıt sayısı.

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 apim api schema show

Düzenle

API Management API Şemasının ayrıntılarını gösterir.

az apim api schema show --api-id
                        --resource-group
                        --schema-id
                        --service-name

Örnekler

API Şeması alma.

az apim api schema show --service-name MyApim -g MyResourceGroup --api-id MyApi --schema-id schemaId

Gerekli Parametreler

--api-id

API tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.

--resource-group -g

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

--schema-id

Şema tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır.

--service-name -n

API Management hizmet örneğinin 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.

--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 apim api schema wait

Düzenle

BIR apim API şeması koşulu karşılanıncaya kadar CLI'yi bekleme durumuna yerleştirin.

az apim api schema wait --api-id
                        --name
                        --resource-group
                        --schema-id
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--interval]
                        [--timeout]
                        [--updated]

Örnekler

BIR apim API şeması koşulu karşılanıncaya kadar CLI'yi bekleme durumuna yerleştirin.

az apim api schema wait --created --api-id MyApi --name MyApim --schema-id schemaId -g MyResourceGroup

Gerekli Parametreler

--api-id

API düzeltme tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Geçerli olmayan düzeltme ; rev=n sonek olarak, n düzeltme numarasıdır. Gerekli.

--name -n

Api management hizmet örneğinin adı.

--resource-group -g

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

--schema-id

Şema kimliği tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. Gerekli.

İsteğe Bağlı Parametreler

--created

'ProvisioningState' ile 'Succeeded' konumunda oluşturulana kadar bekleyin.

Default value: False
--custom

Koşul özel bir JMESPath sorgusunu karşılayana kadar bekleyin. Örneğin provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Silinene kadar bekleyin.

Default value: False
--exists

Kaynak var olana kadar bekleyin.

Default value: False
--interval

Saniye cinsinden yoklama aralığı.

Default value: 30
--timeout

Saniye cinsinden en fazla bekleme.

Default value: 3600
--updated

'Başarılı' konumunda provisioningState ile güncelleştirilene kadar bekleyin.

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.