az apim api schema

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

Komutlar

Name	Description	Tür	Durum
az apim api schema create	API Management API Şeması oluşturma.	Core	GA
az apim api schema delete	API Management API Şemasını silme.	Core	GA
az apim api schema get-etag	API Management API şemasının etag'ini alın.	Core	GA
az apim api schema list	API Management API şemalarını listeleyin.	Core	GA
az apim api schema show	API Management API Şemasının ayrıntılarını gösterir.	Core	GA
az apim api schema wait	BIR apim API şeması koşulu karşılanıncaya kadar CLI'yi bekleme durumuna yerleştirin.	Core	GA

az apim api schema create

API Management API Şeması oluşturma.

az apim api schema create --api-id
                          --resource-group
                          --schema-id
                          --schema-type
                          --service-name
                          [--acquire-policy-token]
                          [--change-reference]
                          [--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.

Özellik	Değer
Parametre grubu:	API Arguments

--resource-group -g

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

Özellik	Değer
Parametre grubu:	Schema Arguments

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

Özellik	Değer
Parametre grubu:	Schema Arguments

--service-name -n

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

--acquire-policy-token

Bu kaynak işlemi için otomatik olarak bir Azure İlkesi belirteci alma.

Özellik	Değer
Parametre grubu:	Global Policy Arguments

--change-reference

Bu kaynak işlemi için ilgili değişiklik başvuru kimliği.

Özellik	Değer
Parametre grubu:	Global Policy Arguments

--no-wait

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

Özellik	Değer
Default value:	False

--resource-type

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

Özellik	Değer
Parametre grubu:	Schema Arguments

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

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

API Management API Şemasını silme.

az apim api schema delete --api-id
                          --resource-group
                          --schema-id
                          --service-name
                          [--acquire-policy-token]
                          [--change-reference]
                          [--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.

Özellik	Değer
Parametre grubu:	API Arguments

--resource-group -g

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

Özellik	Değer
Parametre grubu:	Schema Arguments

--service-name -n

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

--acquire-policy-token

Bu kaynak işlemi için otomatik olarak bir Azure İlkesi belirteci alma.

Özellik	Değer
Parametre grubu:	Global Policy Arguments

--change-reference

Bu kaynak işlemi için ilgili değişiklik başvuru kimliği.

Özellik	Değer
Parametre grubu:	Global Policy Arguments

--if-match

Varlığın ETag'i.

--no-wait

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

Özellik	Değer
Default value:	False

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

--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 apim api schema get-etag

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

az apim api schema get-etag --api-id
                            --resource-group
                            --schema-id
                            --service-name
                            [--acquire-policy-token]
                            [--change-reference]

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

Özellik	Değer
Parametre grubu:	API Arguments

--resource-group -g

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

Özellik	Değer
Parametre grubu:	Schema Arguments

--service-name -n

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

--acquire-policy-token

Bu kaynak işlemi için otomatik olarak bir Azure İlkesi belirteci alma.

Özellik	Değer
Parametre grubu:	Global Policy Arguments

--change-reference

Bu kaynak işlemi için ilgili değişiklik başvuru kimliği.

Özellik	Değer
Parametre grubu:	Global Policy 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 apim api schema list

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.

Özellik	Değer
Parametre grubu:	API Arguments

--resource-group -g

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

--service-name -n

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

API'leri displayName'e göre filtreleyin.

Özellik	Değer
Parametre grubu:	Schema Arguments

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

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

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.

Özellik	Değer
Parametre grubu:	API Arguments

--resource-group -g

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

Özellik	Değer
Parametre grubu:	Schema Arguments

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

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

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
                        [--acquire-policy-token]
                        [--change-reference]
                        [--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. Required.

--name -n

Api management hizmet örneğinin adı.

--resource-group -g

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

--schema-id

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

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

--acquire-policy-token

Bu kaynak işlemi için otomatik olarak bir Azure İlkesi belirteci alma.

Özellik	Değer
Parametre grubu:	Global Policy Arguments

--change-reference

Bu kaynak işlemi için ilgili değişiklik başvuru kimliği.

Özellik	Değer
Parametre grubu:	Global Policy Arguments

--created

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

Özellik	Değer
Parametre grubu:	Wait Condition Arguments
Default value:	False

--custom

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

Özellik	Değer
Parametre grubu:	Wait Condition Arguments

--deleted

Silinene kadar bekleyin.

Özellik	Değer
Parametre grubu:	Wait Condition Arguments
Default value:	False

--exists

Kaynak var olana kadar bekleyin.

Özellik	Değer
Parametre grubu:	Wait Condition Arguments
Default value:	False

--interval

Saniye cinsinden yoklama aralığı.

Özellik	Değer
Parametre grubu:	Wait Condition Arguments
Default value:	30

--timeout

Saniye cinsinden en fazla bekleme.

Özellik	Değer
Parametre grubu:	Wait Condition Arguments
Default value:	3600

--updated

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

Özellik	Değer
Parametre grubu:	Wait Condition Arguments
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/.

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