Bagikan melalui

az apim api schema

  • Referensi

Mengelola Skema API Api Management Azure.

Perintah

Nama Deskripsi Jenis Status
az apim api schema create

Buat Skema API Management API.

 Inti GA
az apim api schema delete

Menghapus Skema API Management API.

 Inti GA
az apim api schema get-etag

Dapatkan etag skema API Management API.

 Inti GA
az apim api schema list

Mencantumkan skema API Management API.

 Inti GA
az apim api schema show

Menampilkan detail Skema API Management API.

 Inti GA
az apim api schema wait

Tempatkan CLI dalam status menunggu sampai kondisi skema apim api terpenuhi.

 Inti GA

az apim api schema create

Edit

Buat Skema API Management API.

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]

Contoh

Buat Skema API.

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

Parameter yang Diperlukan

--api-id

Nama unik api yang skemanya perlu dibuat.

Pengidentifikasi revisi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--schema-id

Nama unik skema api yang akan dibuat.

Pengidentifikasi skema. Harus unik dalam instans layanan API Management saat ini.

--schema-type

Jenis skema (misalnya, application/json, application/vnd.ms-azure-apim.graphql.schema).

Harus berupa jenis media yang valid yang digunakan dalam header Tipe Konten seperti yang didefinisikan dalam RFC 2616. Tipe media dokumen skema.

--service-name -n

Nama instans layanan API Management.

Parameter Opsional

--no-wait

Jangan menunggu operasi jangka panjang selesai.

Nilai default: False
--resource-type

Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts".

--schema-content

String escape Json yang menentukan dokumen yang mewakili Skema.

Tentukan --schema-path atau --schema-content bukan keduanya.

--schema-name

Nama sumber daya skema.

--schema-path

Jalur file yang ditentukan untuk mengimpor skema API.

Tentukan --schema-path atau --schema-content bukan keduanya.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

Nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
Nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az apim api schema delete

Edit

Menghapus Skema API Management API.

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

Contoh

hapus Skema API.

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

Parameter yang Diperlukan

--api-id

Pengidentifikasi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--schema-id

Pengidentifikasi skema. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

--service-name -n

Nama instans layanan API Management.

Parameter Opsional

--if-match

ETag Entitas.

--no-wait

Jangan menunggu operasi jangka panjang selesai.

Nilai default: False
--yes -y

Jangan meminta konfirmasi.

Nilai default: False
Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

Nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
Nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az apim api schema get-etag

Edit

Dapatkan etag skema API Management API.

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

Contoh

mendapatkan tag entitas skema.

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

Parameter yang Diperlukan

--api-id

Pengidentifikasi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--schema-id

Pengidentifikasi skema. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

--service-name -n

Nama instans layanan API Management.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

Nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
Nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az apim api schema list

Edit

Mencantumkan skema API Management API.

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

Contoh

Dapatkan daftar skema yang terkait dengan id api.

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

Parameter yang Diperlukan

--api-id

Pengidentifikasi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--service-name -n

Nama instans layanan API Management.

Parameter Opsional

--filter-display-name

Filter API menurut displayName.

--skip

Jumlah rekaman yang akan dilewati.

--top

Jumlah rekaman yang akan dikembalikan.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

Nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
Nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az apim api schema show

Edit

Menampilkan detail Skema API Management API.

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

Contoh

Dapatkan Skema API.

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

Parameter yang Diperlukan

--api-id

Pengidentifikasi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--schema-id

Pengidentifikasi skema. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.

--service-name -n

Nama instans layanan API Management.

Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

Nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
Nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.

az apim api schema wait

Edit

Tempatkan CLI dalam status menunggu sampai kondisi skema apim api terpenuhi.

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

Contoh

Tempatkan CLI dalam status tunggu sampai kondisi skema apim api terpenuhi.

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

Parameter yang Diperlukan

--api-id

Pengidentifikasi revisi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi. Harus diisi.

--name -n

Nama instans layanan api management.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

--schema-id

Pengidentifikasi id skema. Harus unik dalam instans layanan API Management saat ini. Harus diisi.

Parameter Opsional

--created

Tunggu hingga dibuat dengan 'provisioningState' di 'Berhasil'.

Nilai default: False
--custom

Tunggu hingga kondisi memenuhi kueri JMESPath kustom. Misalnya provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Tunggu hingga dihapus.

Nilai default: False
--exists

Tunggu hingga sumber daya ada.

Nilai default: False
--interval

Interval polling dalam hitungan detik.

Nilai default: 30
--timeout

Tunggu maksimum dalam detik.

Nilai default: 3600
--updated

Tunggu hingga diperbarui dengan provisioningState di 'Berhasil'.

Nilai default: False
Parameter Global
--debug

Meningkatkan verbositas pengelogan untuk menampilkan semua log debug.

--help -h

Menampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya menampilkan kesalahan, menyembunyikan peringatan.

--output -o

Format output.

Nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
Nilai default: json
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi selengkapnya beserta contohnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Meningkatkan verbositas pengelogan. Gunakan --debug untuk log waktu lengkap.